.pydevproject
.project
.settings
-doc/build
+# doc/build
+doc/build/latex/salomeTools.log
.coverage
test/htmlcov
test/test_res.html
--- /dev/null
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2c4d344051e59f2c4840e68130e38438
+tags: fbb0d17656682115ca4d033fb2f83ba1
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Overview: module code — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>All modules for which code is available</h1>
+<ul><li><a href="src/ElementTree.html">src.ElementTree</a></li>
+<li><a href="src/__init__.html">src.__init__</a></li>
+<li><a href="src/architecture.html">src.architecture</a></li>
+<li><a href="src/colorama/ansi.html">src.colorama.ansi</a></li>
+<li><a href="src/colorama/ansitowin32.html">src.colorama.ansitowin32</a></li>
+<li><a href="src/colorama/initialise.html">src.colorama.initialise</a></li>
+<li><a href="src/colorama/win32.html">src.colorama.win32</a></li>
+<li><a href="src/colorama/winterm.html">src.colorama.winterm</a></li>
+<li><a href="src/compilation.html">src.compilation</a></li>
+<li><a href="src/debug.html">src.debug</a></li>
+<li><a href="src/environment.html">src.environment</a></li>
+<li><a href="src/fileEnviron.html">src.fileEnviron</a></li>
+<li><a href="src/fork.html">src.fork</a></li>
+<li><a href="src/logger.html">src.logger</a></li>
+<li><a href="src/options.html">src.options</a></li>
+<li><a href="src/printcolors.html">src.printcolors</a></li>
+<li><a href="src/product.html">src.product</a></li>
+<li><a href="src/pyconf.html">src.pyconf</a></li>
+<li><a href="src/system.html">src.system</a></li>
+<li><a href="src/template.html">src.template</a></li>
+<li><a href="src/test_module.html">src.test_module</a></li>
+<li><a href="src/xmlManager.html">src.xmlManager</a></li>
+</ul>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.ElementTree — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.ElementTree</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># ElementTree</span>
+<span class="c"># $Id: ElementTree.py 2326 2005-03-17 07:45:21Z fredrik $</span>
+<span class="c">#</span>
+<span class="c"># light-weight XML support for Python 1.5.2 and later.</span>
+<span class="c">#</span>
+<span class="c"># history:</span>
+<span class="c"># 2001-10-20 fl created (from various sources)</span>
+<span class="c"># 2001-11-01 fl return root from parse method</span>
+<span class="c"># 2002-02-16 fl sort attributes in lexical order</span>
+<span class="c"># 2002-04-06 fl TreeBuilder refactoring, added PythonDoc markup</span>
+<span class="c"># 2002-05-01 fl finished TreeBuilder refactoring</span>
+<span class="c"># 2002-07-14 fl added basic namespace support to ElementTree.write</span>
+<span class="c"># 2002-07-25 fl added QName attribute support</span>
+<span class="c"># 2002-10-20 fl fixed encoding in write</span>
+<span class="c"># 2002-11-24 fl changed default encoding to ascii; fixed attribute encoding</span>
+<span class="c"># 2002-11-27 fl accept file objects or file names for parse/write</span>
+<span class="c"># 2002-12-04 fl moved XMLTreeBuilder back to this module</span>
+<span class="c"># 2003-01-11 fl fixed entity encoding glitch for us-ascii</span>
+<span class="c"># 2003-02-13 fl added XML literal factory</span>
+<span class="c"># 2003-02-21 fl added ProcessingInstruction/PI factory</span>
+<span class="c"># 2003-05-11 fl added tostring/fromstring helpers</span>
+<span class="c"># 2003-05-26 fl added ElementPath support</span>
+<span class="c"># 2003-07-05 fl added makeelement factory method</span>
+<span class="c"># 2003-07-28 fl added more well-known namespace prefixes</span>
+<span class="c"># 2003-08-15 fl fixed typo in ElementTree.findtext (Thomas Dartsch)</span>
+<span class="c"># 2003-09-04 fl fall back on emulator if ElementPath is not installed</span>
+<span class="c"># 2003-10-31 fl markup updates</span>
+<span class="c"># 2003-11-15 fl fixed nested namespace bug</span>
+<span class="c"># 2004-03-28 fl added XMLID helper</span>
+<span class="c"># 2004-06-02 fl added default support to findtext</span>
+<span class="c"># 2004-06-08 fl fixed encoding of non-ascii element/attribute names</span>
+<span class="c"># 2004-08-23 fl take advantage of post-2.1 expat features</span>
+<span class="c"># 2005-02-01 fl added iterparse implementation</span>
+<span class="c"># 2005-03-02 fl fixed iterparse support for pre-2.2 versions</span>
+<span class="c">#</span>
+<span class="c"># Copyright (c) 1999-2005 by Fredrik Lundh. All rights reserved.</span>
+<span class="c">#</span>
+<span class="c"># fredrik@pythonware.com</span>
+<span class="c"># http://www.pythonware.com</span>
+<span class="c">#</span>
+<span class="c"># --------------------------------------------------------------------</span>
+<span class="c"># The ElementTree toolkit is</span>
+<span class="c">#</span>
+<span class="c"># Copyright (c) 1999-2005 by Fredrik Lundh</span>
+<span class="c">#</span>
+<span class="c"># By obtaining, using, and/or copying this software and/or its</span>
+<span class="c"># associated documentation, you agree that you have read, understood,</span>
+<span class="c"># and will comply with the following terms and conditions:</span>
+<span class="c">#</span>
+<span class="c"># Permission to use, copy, modify, and distribute this software and</span>
+<span class="c"># its associated documentation for any purpose and without fee is</span>
+<span class="c"># hereby granted, provided that the above copyright notice appears in</span>
+<span class="c"># all copies, and that both that copyright notice and this permission</span>
+<span class="c"># notice appear in supporting documentation, and that the name of</span>
+<span class="c"># Secret Labs AB or the author not be used in advertising or publicity</span>
+<span class="c"># pertaining to distribution of the software without specific, written</span>
+<span class="c"># prior permission.</span>
+<span class="c">#</span>
+<span class="c"># SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span>
+<span class="c"># TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-</span>
+<span class="c"># ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR</span>
+<span class="c"># BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY</span>
+<span class="c"># DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,</span>
+<span class="c"># WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS</span>
+<span class="c"># ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE</span>
+<span class="c"># OF THIS SOFTWARE.</span>
+<span class="c"># --------------------------------------------------------------------</span>
+
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="c"># public symbols</span>
+ <span class="s">"Comment"</span><span class="p">,</span>
+ <span class="s">"dump"</span><span class="p">,</span>
+ <span class="s">"Element"</span><span class="p">,</span> <span class="s">"ElementTree"</span><span class="p">,</span>
+ <span class="s">"fromstring"</span><span class="p">,</span>
+ <span class="s">"iselement"</span><span class="p">,</span> <span class="s">"iterparse"</span><span class="p">,</span>
+ <span class="s">"parse"</span><span class="p">,</span>
+ <span class="s">"PI"</span><span class="p">,</span> <span class="s">"ProcessingInstruction"</span><span class="p">,</span>
+ <span class="s">"QName"</span><span class="p">,</span>
+ <span class="s">"SubElement"</span><span class="p">,</span>
+ <span class="s">"tostring"</span><span class="p">,</span>
+ <span class="s">"TreeBuilder"</span><span class="p">,</span>
+ <span class="s">"VERSION"</span><span class="p">,</span> <span class="s">"XML"</span><span class="p">,</span>
+ <span class="s">"XMLTreeBuilder"</span><span class="p">,</span>
+ <span class="p">]</span>
+
+<span class="c">##</span>
+<span class="c"># The <b>Element</b> type is a flexible container object, designed to</span>
+<span class="c"># store hierarchical data structures in memory. The type can be</span>
+<span class="c"># described as a cross between a list and a dictionary.</span>
+<span class="c"># <p></span>
+<span class="c"># Each element has a number of properties associated with it:</span>
+<span class="c"># <ul></span>
+<span class="c"># <li>a <i>tag</i>. This is a string identifying what kind of data</span>
+<span class="c"># this element represents (the element type, in other words).</li></span>
+<span class="c"># <li>a number of <i>attributes</i>, stored in a Python dictionary.</li></span>
+<span class="c"># <li>a <i>text</i> string.</li></span>
+<span class="c"># <li>an optional <i>tail</i> string.</li></span>
+<span class="c"># <li>a number of <i>child elements</i>, stored in a Python sequence</li></span>
+<span class="c"># </ul></span>
+<span class="c">#</span>
+<span class="c"># To create an element instance, use the {@link #Element} or {@link</span>
+<span class="c"># #SubElement} factory functions.</span>
+<span class="c"># <p></span>
+<span class="c"># The {@link #ElementTree} class can be used to wrap an element</span>
+<span class="c"># structure, and convert it from and to XML.</span>
+<span class="c">##</span>
+
+<span class="kn">import</span> <span class="nn">string</span><span class="o">,</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">re</span><span class="o">,</span> <span class="nn">platform</span>
+
+<span class="k">class</span> <span class="nc">_SimpleElementPath</span><span class="p">:</span>
+ <span class="c"># emulate pre-1.2 find/findtext/findall behaviour</span>
+ <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">element</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">elem</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">tag</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">elem</span>
+ <span class="k">return</span> <span class="bp">None</span>
+ <span class="k">def</span> <span class="nf">findtext</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">element</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">elem</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">tag</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">elem</span><span class="o">.</span><span class="n">text</span> <span class="ow">or</span> <span class="s">""</span>
+ <span class="k">return</span> <span class="n">default</span>
+ <span class="k">def</span> <span class="nf">findall</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">tag</span><span class="p">[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s">".//"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">element</span><span class="o">.</span><span class="n">getiterator</span><span class="p">(</span><span class="n">tag</span><span class="p">[</span><span class="mi">3</span><span class="p">:])</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">element</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">elem</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">tag</span><span class="p">:</span>
+ <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">result</span>
+
+<span class="k">try</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">ElementPath</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
+ <span class="c"># FIXME: issue warning in this case?</span>
+ <span class="n">ElementPath</span> <span class="o">=</span> <span class="n">_SimpleElementPath</span><span class="p">()</span>
+
+<span class="c"># TODO: add support for custom namespace resolvers/default namespaces</span>
+<span class="c"># TODO: add improved support for incremental parsing</span>
+
+<span class="n">VERSION</span> <span class="o">=</span> <span class="s">"1.2.6"</span>
+
+<span class="c">##</span>
+<span class="c"># Internal element class. This class defines the Element interface,</span>
+<span class="c"># and provides a reference implementation of this interface.</span>
+<span class="c"># <p></span>
+<span class="c"># You should not create instances of this class directly. Use the</span>
+<span class="c"># appropriate factory functions instead, such as {@link #Element}</span>
+<span class="c"># and {@link #SubElement}.</span>
+<span class="c">#</span>
+<span class="c"># @see Element</span>
+<span class="c"># @see SubElement</span>
+<span class="c"># @see Comment</span>
+<span class="c"># @see ProcessingInstruction</span>
+
+<span class="k">class</span> <span class="nc">_ElementInterface</span><span class="p">:</span>
+ <span class="c"># <tag attrib>text<child/>...</tag>tail</span>
+
+ <span class="c">##</span>
+ <span class="c"># (Attribute) Element tag.</span>
+
+ <span class="n">tag</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c">##</span>
+ <span class="c"># (Attribute) Element attribute dictionary. Where possible, use</span>
+ <span class="c"># {@link #_ElementInterface.get},</span>
+ <span class="c"># {@link #_ElementInterface.set},</span>
+ <span class="c"># {@link #_ElementInterface.keys}, and</span>
+ <span class="c"># {@link #_ElementInterface.items} to access</span>
+ <span class="c"># element attributes.</span>
+
+ <span class="n">attrib</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c">##</span>
+ <span class="c"># (Attribute) Text before first subelement. This is either a</span>
+ <span class="c"># string or the value None, if there was no text.</span>
+
+ <span class="n">text</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c">##</span>
+ <span class="c"># (Attribute) Text after this element's end tag, but before the</span>
+ <span class="c"># next sibling element's start tag. This is either a string or</span>
+ <span class="c"># the value None, if there was no text.</span>
+
+ <span class="n">tail</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># text after end tag, if any</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">tag</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span> <span class="o">=</span> <span class="n">attrib</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">"<Element </span><span class="si">%s</span><span class="s"> at </span><span class="si">%x</span><span class="s">>"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+
+ <span class="c">##</span>
+ <span class="c"># Creates a new element object of the same type as this element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param tag Element tag.</span>
+ <span class="c"># @param attrib Element attributes, given as a dictionary.</span>
+ <span class="c"># @return A new element instance.</span>
+
+ <span class="k">def</span> <span class="nf">makeelement</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Element</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Returns the number of subelements.</span>
+ <span class="c">#</span>
+ <span class="c"># @return The number of subelements.</span>
+
+ <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Returns the given subelement.</span>
+ <span class="c">#</span>
+ <span class="c"># @param index What subelement to return.</span>
+ <span class="c"># @return The given subelement.</span>
+ <span class="c"># @exception IndexError If the given element does not exist.</span>
+
+ <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
+
+ <span class="c">##</span>
+ <span class="c"># Replaces the given subelement.</span>
+ <span class="c">#</span>
+ <span class="c"># @param index What subelement to replace.</span>
+ <span class="c"># @param element The new element value.</span>
+ <span class="c"># @exception IndexError If the given element does not exist.</span>
+ <span class="c"># @exception AssertionError If element is not a valid object.</span>
+
+ <span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">element</span>
+
+ <span class="c">##</span>
+ <span class="c"># Deletes the given subelement.</span>
+ <span class="c">#</span>
+ <span class="c"># @param index What subelement to delete.</span>
+ <span class="c"># @exception IndexError If the given element does not exist.</span>
+
+ <span class="k">def</span> <span class="nf">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
+ <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
+
+ <span class="c">##</span>
+ <span class="c"># Returns a list containing subelements in the given range.</span>
+ <span class="c">#</span>
+ <span class="c"># @param start The first subelement to return.</span>
+ <span class="c"># @param stop The first subelement that shouldn't be returned.</span>
+ <span class="c"># @return A sequence object containing subelements.</span>
+
+ <span class="k">def</span> <span class="nf">__getslice__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">stop</span><span class="p">]</span>
+
+ <span class="c">##</span>
+ <span class="c"># Replaces a number of subelements with elements from a sequence.</span>
+ <span class="c">#</span>
+ <span class="c"># @param start The first subelement to replace.</span>
+ <span class="c"># @param stop The first subelement that shouldn't be replaced.</span>
+ <span class="c"># @param elements A sequence object with zero or more elements.</span>
+ <span class="c"># @exception AssertionError If a sequence member is not a valid object.</span>
+
+ <span class="k">def</span> <span class="nf">__setslice__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">,</span> <span class="n">elements</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">elements</span><span class="p">:</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">stop</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">elements</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Deletes a number of subelements.</span>
+ <span class="c">#</span>
+ <span class="c"># @param start The first subelement to delete.</span>
+ <span class="c"># @param stop The first subelement to leave in there.</span>
+
+ <span class="k">def</span> <span class="nf">__delslice__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">):</span>
+ <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">stop</span><span class="p">]</span>
+
+ <span class="c">##</span>
+ <span class="c"># Adds a subelement to the end of this element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param element The element to add.</span>
+ <span class="c"># @exception AssertionError If a sequence member is not a valid object.</span>
+
+ <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Inserts a subelement at the given position in this element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param index Where to insert the new subelement.</span>
+ <span class="c"># @exception AssertionError If the element is not a valid object.</span>
+
+ <span class="k">def</span> <span class="nf">insert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Removes a matching subelement. Unlike the <b>find</b> methods,</span>
+ <span class="c"># this method compares elements based on identity, not on tag</span>
+ <span class="c"># value or contents.</span>
+ <span class="c">#</span>
+ <span class="c"># @param element What element to remove.</span>
+ <span class="c"># @exception ValueError If a matching element could not be found.</span>
+ <span class="c"># @exception AssertionError If the element is not a valid object.</span>
+
+ <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Returns all subelements. The elements are returned in document</span>
+ <span class="c"># order.</span>
+ <span class="c">#</span>
+ <span class="c"># @return A list of subelements.</span>
+ <span class="c"># @defreturn list of Element instances</span>
+
+ <span class="k">def</span> <span class="nf">getchildren</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds the first matching subelement, by tag name or path.</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What element to look for.</span>
+ <span class="c"># @return The first matching element, or None if no element was found.</span>
+ <span class="c"># @defreturn Element or None</span>
+
+ <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">ElementPath</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ElementPath</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
+ <span class="k">return</span> <span class="n">ElementPath</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds text for the first matching subelement, by tag name or path.</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What element to look for.</span>
+ <span class="c"># @param default What to return if the element was not found.</span>
+ <span class="c"># @return The text content of the first matching element, or the</span>
+ <span class="c"># default value no element was found. Note that if the element</span>
+ <span class="c"># has is found, but has no text content, this method returns an</span>
+ <span class="c"># empty string.</span>
+ <span class="c"># @defreturn string</span>
+
+ <span class="k">def</span> <span class="nf">findtext</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">ElementPath</span><span class="o">.</span><span class="n">findtext</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds all matching subelements, by tag name or path.</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What element to look for.</span>
+ <span class="c"># @return A list or iterator containing all matching elements,</span>
+ <span class="c"># in document order.</span>
+ <span class="c"># @defreturn list of Element instances</span>
+
+ <span class="k">def</span> <span class="nf">findall</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">ElementPath</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Resets an element. This function removes all subelements, clears</span>
+ <span class="c"># all attributes, and sets the text and tail attributes to None.</span>
+
+ <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_children</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tail</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c">##</span>
+ <span class="c"># Gets an element attribute.</span>
+ <span class="c">#</span>
+ <span class="c"># @param key What attribute to look for.</span>
+ <span class="c"># @param default What to return if the attribute was not found.</span>
+ <span class="c"># @return The attribute value, or the default value, if the</span>
+ <span class="c"># attribute was not found.</span>
+ <span class="c"># @defreturn string or None</span>
+
+ <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">res</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="o">.</span><span class="n">encode</span><span class="p">(),</span> <span class="n">default</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">res</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+
+ <span class="c">##</span>
+ <span class="c"># Sets an element attribute.</span>
+ <span class="c">#</span>
+ <span class="c"># @param key What attribute to set.</span>
+ <span class="c"># @param value The attribute value.</span>
+
+ <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+
+ <span class="c">##</span>
+ <span class="c"># Gets a list of attribute names. The names are returned in an</span>
+ <span class="c"># arbitrary order (just like for an ordinary Python dictionary).</span>
+ <span class="c">#</span>
+ <span class="c"># @return A list of element attribute names.</span>
+ <span class="c"># @defreturn list of strings</span>
+
+ <span class="k">def</span> <span class="nf">keys</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span>
+
+ <span class="c">##</span>
+ <span class="c"># Gets element attributes, as a sequence. The attributes are</span>
+ <span class="c"># returned in an arbitrary order.</span>
+ <span class="c">#</span>
+ <span class="c"># @return A list of (name, value) tuples for all attributes.</span>
+ <span class="c"># @defreturn list of (string, string) tuples</span>
+
+ <span class="k">def</span> <span class="nf">items</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
+
+ <span class="c">##</span>
+ <span class="c"># Creates a tree iterator. The iterator loops over this element</span>
+ <span class="c"># and all subelements, in document order, and returns all elements</span>
+ <span class="c"># with a matching tag.</span>
+ <span class="c"># <p></span>
+ <span class="c"># If the tree structure is modified during iteration, the result</span>
+ <span class="c"># is undefined.</span>
+ <span class="c">#</span>
+ <span class="c"># @param tag What tags to look for (default is to return all elements).</span>
+ <span class="c"># @return A list or iterator containing all the matching elements.</span>
+ <span class="c"># @defreturn list or iterator</span>
+
+ <span class="k">def</span> <span class="nf">getiterator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="n">nodes</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">"*"</span><span class="p">:</span>
+ <span class="n">tag</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">tag</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">tag</span><span class="p">:</span>
+ <span class="n">nodes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_children</span><span class="p">:</span>
+ <span class="n">nodes</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">getiterator</span><span class="p">(</span><span class="n">tag</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">nodes</span>
+
+<span class="c"># compatibility</span>
+<span class="n">_Element</span> <span class="o">=</span> <span class="n">_ElementInterface</span>
+
+<span class="c">##</span>
+<span class="c"># Element factory. This function returns an object implementing the</span>
+<span class="c"># standard Element interface. The exact class or type of that object</span>
+<span class="c"># is implementation dependent, but it will always be compatible with</span>
+<span class="c"># the {@link #_ElementInterface} class in this module.</span>
+<span class="c"># <p></span>
+<span class="c"># The element name, attribute names, and attribute values can be</span>
+<span class="c"># either 8-bit ASCII strings or Unicode strings.</span>
+<span class="c">#</span>
+<span class="c"># @param tag The element name.</span>
+<span class="c"># @param attrib An optional dictionary, containing element attributes.</span>
+<span class="c"># @param **extra Additional attributes, given as keyword arguments.</span>
+<span class="c"># @return An element instance.</span>
+<span class="c"># @defreturn Element</span>
+
+<div class="viewcode-block" id="Element"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.Element">[docs]</a><span class="k">def</span> <span class="nf">Element</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{},</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="n">attrib</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">attrib</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">_ElementInterface</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">)</span>
+
+<span class="c">##</span>
+<span class="c"># Subelement factory. This function creates an element instance, and</span>
+<span class="c"># appends it to an existing element.</span>
+<span class="c"># <p></span>
+<span class="c"># The element name, attribute names, and attribute values can be</span>
+<span class="c"># either 8-bit ASCII strings or Unicode strings.</span>
+<span class="c">#</span>
+<span class="c"># @param parent The parent element.</span>
+<span class="c"># @param tag The subelement name.</span>
+<span class="c"># @param attrib An optional dictionary, containing element attributes.</span>
+<span class="c"># @param **extra Additional attributes, given as keyword arguments.</span>
+<span class="c"># @return An element instance.</span>
+<span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="SubElement"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.SubElement">[docs]</a><span class="k">def</span> <span class="nf">SubElement</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{},</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="n">attrib</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">attrib</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
+ <span class="n">element</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">makeelement</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">)</span>
+ <span class="n">parent</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">element</span>
+
+<span class="c">##</span>
+<span class="c"># Comment element factory. This factory function creates a special</span>
+<span class="c"># element that will be serialized as an XML comment.</span>
+<span class="c"># <p></span>
+<span class="c"># The comment string can be either an 8-bit ASCII string or a Unicode</span>
+<span class="c"># string.</span>
+<span class="c">#</span>
+<span class="c"># @param text A string containing the comment string.</span>
+<span class="c"># @return An element instance, representing a comment.</span>
+<span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="Comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.Comment">[docs]</a><span class="k">def</span> <span class="nf">Comment</span><span class="p">(</span><span class="n">text</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="n">element</span> <span class="o">=</span> <span class="n">Element</span><span class="p">(</span><span class="n">Comment</span><span class="p">)</span>
+ <span class="n">element</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="k">return</span> <span class="n">element</span>
+
+<span class="c">##</span>
+<span class="c"># PI element factory. This factory function creates a special element</span>
+<span class="c"># that will be serialized as an XML processing instruction.</span>
+<span class="c">#</span>
+<span class="c"># @param target A string containing the PI target.</span>
+<span class="c"># @param text A string containing the PI contents, if any.</span>
+<span class="c"># @return An element instance, representing a PI.</span>
+<span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="ProcessingInstruction"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ProcessingInstruction">[docs]</a><span class="k">def</span> <span class="nf">ProcessingInstruction</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="n">element</span> <span class="o">=</span> <span class="n">Element</span><span class="p">(</span><span class="n">ProcessingInstruction</span><span class="p">)</span>
+ <span class="n">element</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">target</span>
+ <span class="k">if</span> <span class="n">text</span><span class="p">:</span>
+ <span class="n">element</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">element</span><span class="o">.</span><span class="n">text</span> <span class="o">+</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">text</span>
+ <span class="k">return</span> <span class="n">element</span>
+</div>
+<span class="n">PI</span> <span class="o">=</span> <span class="n">ProcessingInstruction</span>
+
+<span class="c">##</span>
+<span class="c"># QName wrapper. This can be used to wrap a QName attribute value, in</span>
+<span class="c"># order to get proper namespace handling on output.</span>
+<span class="c">#</span>
+<span class="c"># @param text A string containing the QName value, in the form {uri}local,</span>
+<span class="c"># or, if the tag argument is given, the URI part of a QName.</span>
+<span class="c"># @param tag Optional tag. If given, the first argument is interpreted as</span>
+<span class="c"># an URI, and this argument is interpreted as a local name.</span>
+<span class="c"># @return An opaque object, representing the QName.</span>
+
+<div class="viewcode-block" id="QName"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.QName">[docs]</a><span class="k">class</span> <span class="nc">QName</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text_or_uri</span><span class="p">,</span> <span class="n">tag</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">tag</span><span class="p">:</span>
+ <span class="n">text_or_uri</span> <span class="o">=</span> <span class="s">"{</span><span class="si">%s</span><span class="s">}</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">text_or_uri</span><span class="p">,</span> <span class="n">tag</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text_or_uri</span>
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">text</span>
+ <span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">def</span> <span class="nf">__cmp__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">QName</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">cmp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">return</span> <span class="nb">cmp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
+
+<span class="c">##</span>
+<span class="c"># ElementTree wrapper class. This class represents an entire element</span>
+<span class="c"># hierarchy, and adds some extra support for serialization to and from</span>
+<span class="c"># standard XML.</span>
+<span class="c">#</span>
+<span class="c"># @param element Optional root element.</span>
+<span class="c"># @keyparam file Optional file handle or name. If given, the</span>
+<span class="c"># tree is initialized with the contents of this XML file.</span>
+</div>
+<div class="viewcode-block" id="ElementTree"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree">[docs]</a><span class="k">class</span> <span class="nc">ElementTree</span><span class="p">:</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="nb">file</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">element</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="o">=</span> <span class="n">element</span> <span class="c"># first node</span>
+ <span class="k">if</span> <span class="nb">file</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Gets the root element for this tree.</span>
+ <span class="c">#</span>
+ <span class="c"># @return An element instance.</span>
+ <span class="c"># @defreturn Element</span>
+
+<div class="viewcode-block" id="ElementTree.getroot"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.getroot">[docs]</a> <span class="k">def</span> <span class="nf">getroot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span>
+
+ <span class="c">##</span>
+ <span class="c"># Replaces the root element for this tree. This discards the</span>
+ <span class="c"># current contents of the tree, and replaces it with the given</span>
+ <span class="c"># element. Use with care.</span>
+ <span class="c">#</span>
+ <span class="c"># @param element An element instance.</span>
+</div>
+ <span class="k">def</span> <span class="nf">_setroot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="n">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="o">=</span> <span class="n">element</span>
+
+ <span class="c">##</span>
+ <span class="c"># Loads an external XML document into this element tree.</span>
+ <span class="c">#</span>
+ <span class="c"># @param source A file name or file object.</span>
+ <span class="c"># @param parser An optional parser instance. If not given, the</span>
+ <span class="c"># standard {@link XMLTreeBuilder} parser is used.</span>
+ <span class="c"># @return The document root element.</span>
+ <span class="c"># @defreturn Element</span>
+
+<div class="viewcode-block" id="ElementTree.parse"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.parse">[docs]</a> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s">"read"</span><span class="p">):</span>
+ <span class="c"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
+ <span class="c"># de remontee de log des tests</span>
+ <span class="c">#print "TRACES OP - ElementTree.py/ElementTree.parse() source = '#%s#'" %source</span>
+ <span class="n">source</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s">"rb"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">parser</span><span class="p">:</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">XMLTreeBuilder</span><span class="p">()</span>
+ <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">32768</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">data</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span>
+
+ <span class="c">##</span>
+ <span class="c"># Creates a tree iterator for the root element. The iterator loops</span>
+ <span class="c"># over all elements in this tree, in document order.</span>
+ <span class="c">#</span>
+ <span class="c"># @param tag What tags to look for (default is to return all elements)</span>
+ <span class="c"># @return An iterator.</span>
+ <span class="c"># @defreturn iterator</span>
+</div>
+<div class="viewcode-block" id="ElementTree.getiterator"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.getiterator">[docs]</a> <span class="k">def</span> <span class="nf">getiterator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span><span class="o">.</span><span class="n">getiterator</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds the first toplevel element with given tag.</span>
+ <span class="c"># Same as getroot().find(path).</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What element to look for.</span>
+ <span class="c"># @return The first matching element, or None if no element was found.</span>
+ <span class="c"># @defreturn Element or None</span>
+</div>
+<div class="viewcode-block" id="ElementTree.find"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.find">[docs]</a> <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">path</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"/"</span><span class="p">:</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="s">"."</span> <span class="o">+</span> <span class="n">path</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds the element text for the first toplevel element with given</span>
+ <span class="c"># tag. Same as getroot().findtext(path).</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What toplevel element to look for.</span>
+ <span class="c"># @param default What to return if the element was not found.</span>
+ <span class="c"># @return The text content of the first matching element, or the</span>
+ <span class="c"># default value no element was found. Note that if the element</span>
+ <span class="c"># has is found, but has no text content, this method returns an</span>
+ <span class="c"># empty string.</span>
+ <span class="c"># @defreturn string</span>
+</div>
+<div class="viewcode-block" id="ElementTree.findtext"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.findtext">[docs]</a> <span class="k">def</span> <span class="nf">findtext</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">path</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"/"</span><span class="p">:</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="s">"."</span> <span class="o">+</span> <span class="n">path</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span><span class="o">.</span><span class="n">findtext</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finds all toplevel elements with the given tag.</span>
+ <span class="c"># Same as getroot().findall(path).</span>
+ <span class="c">#</span>
+ <span class="c"># @param path What element to look for.</span>
+ <span class="c"># @return A list or iterator containing all matching elements,</span>
+ <span class="c"># in document order.</span>
+ <span class="c"># @defreturn list of Element instances</span>
+</div>
+<div class="viewcode-block" id="ElementTree.findall"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.findall">[docs]</a> <span class="k">def</span> <span class="nf">findall</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">path</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"/"</span><span class="p">:</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="s">"."</span> <span class="o">+</span> <span class="n">path</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Writes the element tree to a file, as XML.</span>
+ <span class="c">#</span>
+ <span class="c"># @param file A file name, or a file object opened for writing.</span>
+ <span class="c"># @param encoding Optional output encoding (default is US-ASCII).</span>
+</div>
+<div class="viewcode-block" id="ElementTree.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">file</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">"us-ascii"</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="s">"write"</span><span class="p">):</span>
+ <span class="nb">file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="s">"wb"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">encoding</span><span class="p">:</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">"us-ascii"</span>
+ <span class="k">elif</span> <span class="n">encoding</span> <span class="o">!=</span> <span class="s">"utf-8"</span> <span class="ow">and</span> <span class="n">encoding</span> <span class="o">!=</span> <span class="s">"us-ascii"</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?xml version='1.0' encoding='</span><span class="si">%s</span><span class="s">'?></span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">encoding</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_write</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span><span class="p">,</span> <span class="n">encoding</span><span class="p">,</span> <span class="p">{})</span>
+</div>
+ <span class="k">def</span> <span class="nf">_write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">file</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">encoding</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">,</span> <span class="n">margin</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="c"># write XML to file</span>
+ <span class="n">tag</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">tag</span>
+ <span class="k">if</span> <span class="n">tag</span> <span class="ow">is</span> <span class="n">Comment</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<!-- </span><span class="si">%s</span><span class="s"> --></span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">_escape_cdata</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+ <span class="k">elif</span> <span class="n">tag</span> <span class="ow">is</span> <span class="n">ProcessingInstruction</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?</span><span class="si">%s</span><span class="s">?></span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">_escape_cdata</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">items</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
+ <span class="n">xmlns_items</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># new namespaces in this scope</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">QName</span><span class="p">)</span> <span class="ow">or</span> <span class="n">tag</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"{"</span><span class="p">:</span>
+ <span class="n">tag</span><span class="p">,</span> <span class="n">xmlns</span> <span class="o">=</span> <span class="n">fixtag</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">xmlns</span><span class="p">:</span> <span class="n">xmlns_items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">xmlns</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' '</span> <span class="o">*</span> <span class="n">margin</span><span class="p">)</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_encode</span><span class="p">(</span><span class="s">"<"</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span> <span class="o">+</span> <span class="n">_encode</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">items</span> <span class="ow">or</span> <span class="n">xmlns_items</span><span class="p">:</span>
+ <span class="n">items</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">items</span><span class="p">)</span> <span class="c"># lexical order</span>
+ <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">QName</span><span class="p">)</span> <span class="ow">or</span> <span class="n">k</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"{"</span><span class="p">:</span>
+ <span class="n">k</span><span class="p">,</span> <span class="n">xmlns</span> <span class="o">=</span> <span class="n">fixtag</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">xmlns</span><span class="p">:</span> <span class="n">xmlns_items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">xmlns</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">k</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">QName</span><span class="p">):</span>
+ <span class="n">v</span><span class="p">,</span> <span class="n">xmlns</span> <span class="o">=</span> <span class="n">fixtag</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">xmlns</span><span class="p">:</span> <span class="n">xmlns_items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">xmlns</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s">=</span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">xmlns_items</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s">=</span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">text</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">node</span><span class="p">):</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_escape_cdata</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">node</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_write</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="n">encoding</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">,</span> <span class="n">margin</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' '</span> <span class="o">*</span> <span class="n">margin</span><span class="p">)</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_encode</span><span class="p">(</span><span class="s">"</"</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span> <span class="o">+</span> <span class="n">_encode</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span> <span class="o">+</span> <span class="n">_encode</span><span class="p">(</span><span class="s">"></span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"/></span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">xmlns_items</span><span class="p">:</span>
+ <span class="k">del</span> <span class="n">namespaces</span><span class="p">[</span><span class="n">v</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">tail</span><span class="p">:</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_escape_cdata</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">tail</span><span class="p">,</span> <span class="n">encoding</span><span class="p">))</span>
+
+<span class="c"># --------------------------------------------------------------------</span>
+<span class="c"># helpers</span>
+
+<span class="c">##</span>
+<span class="c"># Checks if an object appears to be a valid element object.</span>
+<span class="c">#</span>
+<span class="c"># @param An element instance.</span>
+<span class="c"># @return A true value if this is an element object.</span>
+<span class="c"># @defreturn flag</span>
+</div>
+<div class="viewcode-block" id="iselement"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.iselement">[docs]</a><span class="k">def</span> <span class="nf">iselement</span><span class="p">(</span><span class="n">element</span><span class="p">):</span>
+ <span class="c"># FIXME: not sure about this; might be a better idea to look</span>
+ <span class="c"># for tag/attrib/text attributes</span>
+ <span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">_ElementInterface</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="s">"tag"</span><span class="p">)</span>
+
+<span class="c">##</span>
+<span class="c"># Writes an element tree or element structure to sys.stdout. This</span>
+<span class="c"># function should be used for debugging only.</span>
+<span class="c"># <p></span>
+<span class="c"># The exact output format is implementation dependent. In this</span>
+<span class="c"># version, it's written as an ordinary XML file.</span>
+<span class="c">#</span>
+<span class="c"># @param elem An element tree or an individual element.</span>
+</div>
+<div class="viewcode-block" id="dump"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.dump">[docs]</a><span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="n">elem</span><span class="p">):</span>
+ <span class="c"># debugging</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">elem</span><span class="p">,</span> <span class="n">ElementTree</span><span class="p">):</span>
+ <span class="n">elem</span> <span class="o">=</span> <span class="n">ElementTree</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="n">elem</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="n">tail</span> <span class="o">=</span> <span class="n">elem</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span><span class="o">.</span><span class="n">tail</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">tail</span> <span class="ow">or</span> <span class="n">tail</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+</div>
+<span class="k">def</span> <span class="nf">_encode</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">s</span> <span class="c"># 1.5.2: assume the string uses the right encoding</span>
+
+<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version</span><span class="p">[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s">"1.5"</span><span class="p">:</span>
+ <span class="n">_escape</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r"[&<></span><span class="se">\"</span><span class="s">\x80-\xff]+"</span><span class="p">)</span> <span class="c"># 1.5.2</span>
+<span class="k">else</span><span class="p">:</span>
+ <span class="n">_escape</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="nb">eval</span><span class="p">(</span><span class="s">r'u"[&<>\"\u0080-\uffff]+"'</span><span class="p">))</span>
+
+<span class="n">_escape_map</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s">"&"</span><span class="p">:</span> <span class="s">"&amp;"</span><span class="p">,</span>
+ <span class="s">"<"</span><span class="p">:</span> <span class="s">"&lt;"</span><span class="p">,</span>
+ <span class="s">">"</span><span class="p">:</span> <span class="s">"&gt;"</span><span class="p">,</span>
+ <span class="s">'"'</span><span class="p">:</span> <span class="s">"&quot;"</span><span class="p">,</span>
+<span class="p">}</span>
+
+<span class="n">_namespace_map</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="c"># "well-known" namespace prefixes</span>
+ <span class="s">"http://www.w3.org/XML/1998/namespace"</span><span class="p">:</span> <span class="s">"xml"</span><span class="p">,</span>
+ <span class="s">"http://www.w3.org/1999/xhtml"</span><span class="p">:</span> <span class="s">"html"</span><span class="p">,</span>
+ <span class="s">"http://www.w3.org/1999/02/22-rdf-syntax-ns#"</span><span class="p">:</span> <span class="s">"rdf"</span><span class="p">,</span>
+ <span class="s">"http://schemas.xmlsoap.org/wsdl/"</span><span class="p">:</span> <span class="s">"wsdl"</span><span class="p">,</span>
+<span class="p">}</span>
+
+<span class="k">def</span> <span class="nf">_raise_serialization_error</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
+ <span class="s">"cannot serialize </span><span class="si">%r</span><span class="s"> (type </span><span class="si">%s</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">text</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
+ <span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">_encode_entity</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">pattern</span><span class="o">=</span><span class="n">_escape</span><span class="p">):</span>
+ <span class="c"># map reserved and non-ascii characters to numerical entities</span>
+ <span class="k">def</span> <span class="nf">escape_entities</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="nb">map</span><span class="o">=</span><span class="n">_escape_map</span><span class="p">):</span>
+ <span class="n">out</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">append</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">append</span>
+ <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">():</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="nb">map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">char</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">text</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="s">"&#</span><span class="si">%d</span><span class="s">;"</span> <span class="o">%</span> <span class="nb">ord</span><span class="p">(</span><span class="n">char</span><span class="p">)</span>
+ <span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">string</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="s">""</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_encode</span><span class="p">(</span><span class="n">pattern</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">escape_entities</span><span class="p">,</span> <span class="n">text</span><span class="p">),</span> <span class="s">"ascii"</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+<span class="c">#</span>
+<span class="c"># the following functions assume an ascii-compatible encoding</span>
+<span class="c"># (or "utf-16")</span>
+
+<span class="k">def</span> <span class="nf">_escape_cdata</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">replace</span><span class="p">):</span>
+ <span class="c"># escape character data</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'2'</span><span class="p">:</span> <span class="c"># python 2.x.y</span>
+ <span class="k">if</span> <span class="n">encoding</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">_encode</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_encode_entity</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"&"</span><span class="p">,</span> <span class="s">"&amp;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"<"</span><span class="p">,</span> <span class="s">"&lt;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">">"</span><span class="p">,</span> <span class="s">"&gt;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"####newLine####"</span><span class="p">,</span> <span class="s">"<br \>"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">encoding</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">_encode</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_encode_entity</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">text</span>
+ <span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">_escape_attrib</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">replace</span><span class="p">):</span>
+ <span class="c"># escape attribute value</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"&"</span><span class="p">,</span> <span class="s">"&amp;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"'"</span><span class="p">,</span> <span class="s">"&apos;"</span><span class="p">)</span> <span class="c"># FIXME: overkill</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"</span><span class="se">\"</span><span class="s">"</span><span class="p">,</span> <span class="s">"&quot;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"<"</span><span class="p">,</span> <span class="s">"&lt;"</span><span class="p">)</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">">"</span><span class="p">,</span> <span class="s">"&gt;"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">encoding</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">_encode</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_encode_entity</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">text</span>
+ <span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
+ <span class="n">_raise_serialization_error</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">fixtag</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">):</span>
+ <span class="c"># given a decorated tag (of the form {uri}tag), return prefixed</span>
+ <span class="c"># tag and namespace declaration, if any</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">QName</span><span class="p">):</span>
+ <span class="n">tag</span> <span class="o">=</span> <span class="n">tag</span><span class="o">.</span><span class="n">text</span>
+ <span class="n">namespace_uri</span><span class="p">,</span> <span class="n">tag</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">tag</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="s">"}"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="n">namespaces</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">namespace_uri</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">prefix</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="n">_namespace_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">namespace_uri</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">prefix</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="s">"ns</span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">namespaces</span><span class="p">)</span>
+ <span class="n">namespaces</span><span class="p">[</span><span class="n">namespace_uri</span><span class="p">]</span> <span class="o">=</span> <span class="n">prefix</span>
+ <span class="k">if</span> <span class="n">prefix</span> <span class="o">==</span> <span class="s">"xml"</span><span class="p">:</span>
+ <span class="n">xmlns</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">xmlns</span> <span class="o">=</span> <span class="p">(</span><span class="s">"xmlns:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">namespace_uri</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">xmlns</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">tag</span><span class="p">),</span> <span class="n">xmlns</span>
+
+<span class="c">##</span>
+<span class="c"># Parses an XML document into an element tree.</span>
+<span class="c">#</span>
+<span class="c"># @param source A filename or file object containing XML data.</span>
+<span class="c"># @param parser An optional parser instance. If not given, the</span>
+<span class="c"># standard {@link XMLTreeBuilder} parser is used.</span>
+<span class="c"># @return An ElementTree instance</span>
+
+<div class="viewcode-block" id="parse"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.parse">[docs]</a><span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="c"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
+ <span class="c"># de remontee de log des tests</span>
+ <span class="c">#print "TRACES OP - ElementTree.py/parse() source = '#%s#'" %source</span>
+ <span class="n">tree</span> <span class="o">=</span> <span class="n">ElementTree</span><span class="p">()</span>
+ <span class="n">tree</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">tree</span>
+
+<span class="c">##</span>
+<span class="c"># Parses an XML document into an element tree incrementally, and reports</span>
+<span class="c"># what's going on to the user.</span>
+<span class="c">#</span>
+<span class="c"># @param source A filename or file object containing XML data.</span>
+<span class="c"># @param events A list of events to report back. If omitted, only "end"</span>
+<span class="c"># events are reported.</span>
+<span class="c"># @return A (event, elem) iterator.</span>
+</div>
+<div class="viewcode-block" id="iterparse"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.iterparse">[docs]</a><span class="k">class</span> <span class="nc">iterparse</span><span class="p">:</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">events</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s">"read"</span><span class="p">):</span>
+ <span class="c"># OP TEST</span>
+ <span class="k">print</span> <span class="s">"iterparse.__init__ source = </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span><span class="n">source</span>
+ <span class="n">source</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s">"rb"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_file</span> <span class="o">=</span> <span class="n">source</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_events</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_index</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span> <span class="o">=</span> <span class="n">XMLTreeBuilder</span><span class="p">()</span>
+ <span class="c"># wire up the parser for event reporting</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">_parser</span>
+ <span class="n">append</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_events</span><span class="o">.</span><span class="n">append</span>
+ <span class="k">if</span> <span class="n">events</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">events</span> <span class="o">=</span> <span class="p">[</span><span class="s">"end"</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">event</span> <span class="ow">in</span> <span class="n">events</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">event</span> <span class="o">==</span> <span class="s">"start"</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">ordered_attributes</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">specified_attributes</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="n">event</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="n">append</span><span class="p">,</span>
+ <span class="n">start</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">_start_list</span><span class="p">):</span>
+ <span class="n">append</span><span class="p">((</span><span class="n">event</span><span class="p">,</span> <span class="n">start</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">)))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">StartElementHandler</span> <span class="o">=</span> <span class="n">handler</span>
+ <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="n">event</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="n">append</span><span class="p">,</span>
+ <span class="n">start</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">_start</span><span class="p">):</span>
+ <span class="n">append</span><span class="p">((</span><span class="n">event</span><span class="p">,</span> <span class="n">start</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">)))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">StartElementHandler</span> <span class="o">=</span> <span class="n">handler</span>
+ <span class="k">elif</span> <span class="n">event</span> <span class="o">==</span> <span class="s">"end"</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="n">event</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="n">append</span><span class="p">,</span>
+ <span class="n">end</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">_end</span><span class="p">):</span>
+ <span class="n">append</span><span class="p">((</span><span class="n">event</span><span class="p">,</span> <span class="n">end</span><span class="p">(</span><span class="n">tag</span><span class="p">)))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">EndElementHandler</span> <span class="o">=</span> <span class="n">handler</span>
+ <span class="k">elif</span> <span class="n">event</span> <span class="o">==</span> <span class="s">"start-ns"</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">uri</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="n">event</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="n">append</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">uri</span> <span class="o">=</span> <span class="n">_encode</span><span class="p">(</span><span class="n">uri</span><span class="p">,</span> <span class="s">"ascii"</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="n">append</span><span class="p">((</span><span class="n">event</span><span class="p">,</span> <span class="p">(</span><span class="n">prefix</span> <span class="ow">or</span> <span class="s">""</span><span class="p">,</span> <span class="n">uri</span><span class="p">)))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">StartNamespaceDeclHandler</span> <span class="o">=</span> <span class="n">handler</span>
+ <span class="k">elif</span> <span class="n">event</span> <span class="o">==</span> <span class="s">"end-ns"</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="n">event</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="n">append</span><span class="p">):</span>
+ <span class="n">append</span><span class="p">((</span><span class="n">event</span><span class="p">,</span> <span class="bp">None</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">EndNamespaceDeclHandler</span> <span class="o">=</span> <span class="n">handler</span>
+
+<div class="viewcode-block" id="iterparse.next"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.iterparse.next">[docs]</a> <span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">item</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_events</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_index</span><span class="p">]</span>
+ <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_root</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">StopIteration</span>
+ <span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">IndexError</span>
+ <span class="c"># load event buffer</span>
+ <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_events</span><span class="p">[:]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_index</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_file</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">16384</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">data</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_root</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_index</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_index</span> <span class="o">+</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">item</span>
+</div>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="nb">iter</span>
+ <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span>
+ <span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
+
+<span class="c">##</span>
+<span class="c"># Parses an XML document from a string constant. This function can</span>
+<span class="c"># be used to embed "XML literals" in Python code.</span>
+<span class="c">#</span>
+<span class="c"># @param source A string containing XML data.</span>
+<span class="c"># @return An Element instance.</span>
+<span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="XML"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XML">[docs]</a><span class="k">def</span> <span class="nf">XML</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">XMLTreeBuilder</span><span class="p">()</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">parser</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+<span class="c">##</span>
+<span class="c"># Parses an XML document from a string constant, and also returns</span>
+<span class="c"># a dictionary which maps from element id:s to elements.</span>
+<span class="c">#</span>
+<span class="c"># @param source A string containing XML data.</span>
+<span class="c"># @return A tuple containing an Element instance and a dictionary.</span>
+<span class="c"># @defreturn (Element, dictionary)</span>
+</div>
+<span class="k">def</span> <span class="nf">XMLID</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">XMLTreeBuilder</span><span class="p">()</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="n">tree</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">ids</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">tree</span><span class="o">.</span><span class="n">getiterator</span><span class="p">():</span>
+ <span class="nb">id</span> <span class="o">=</span> <span class="n">elem</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"id"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">id</span><span class="p">:</span>
+ <span class="n">ids</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">elem</span>
+ <span class="k">return</span> <span class="n">tree</span><span class="p">,</span> <span class="n">ids</span>
+
+<span class="c">##</span>
+<span class="c"># Parses an XML document from a string constant. Same as {@link #XML}.</span>
+<span class="c">#</span>
+<span class="c"># @def fromstring(text)</span>
+<span class="c"># @param source A string containing XML data.</span>
+<span class="c"># @return An Element instance.</span>
+<span class="c"># @defreturn Element</span>
+
+<span class="n">fromstring</span> <span class="o">=</span> <span class="n">XML</span>
+
+<span class="c">##</span>
+<span class="c"># Generates a string representation of an XML element, including all</span>
+<span class="c"># subelements.</span>
+<span class="c">#</span>
+<span class="c"># @param element An Element instance.</span>
+<span class="c"># @return An encoded string containing the XML data.</span>
+<span class="c"># @defreturn string</span>
+
+<div class="viewcode-block" id="tostring"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.tostring">[docs]</a><span class="k">def</span> <span class="nf">tostring</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">class</span> <span class="nc">dummy</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="nb">file</span> <span class="o">=</span> <span class="n">dummy</span><span class="p">()</span>
+ <span class="nb">file</span><span class="o">.</span><span class="n">write</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">append</span>
+ <span class="n">ElementTree</span><span class="p">(</span><span class="n">element</span><span class="p">)</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
+ <span class="n">data2</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">item</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="n">data2</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
+ <span class="k">return</span> <span class="s">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data2</span><span class="p">)</span>
+
+<span class="c">##</span>
+<span class="c"># Generic element structure builder. This builder converts a sequence</span>
+<span class="c"># of {@link #TreeBuilder.start}, {@link #TreeBuilder.data}, and {@link</span>
+<span class="c"># #TreeBuilder.end} method calls to a well-formed element structure.</span>
+<span class="c"># <p></span>
+<span class="c"># You can use this class to build an element structure using a custom XML</span>
+<span class="c"># parser, or a parser for some other XML-like format.</span>
+<span class="c">#</span>
+<span class="c"># @param element_factory Optional element factory. This factory</span>
+<span class="c"># is called to create new Element instances, as necessary.</span>
+</div>
+<div class="viewcode-block" id="TreeBuilder"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.TreeBuilder">[docs]</a><span class="k">class</span> <span class="nc">TreeBuilder</span><span class="p">:</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element_factory</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_data</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># data collector</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_elem</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># element stack</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># last element</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_tail</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># true if we're after an end tag</span>
+ <span class="k">if</span> <span class="n">element_factory</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">element_factory</span> <span class="o">=</span> <span class="n">_ElementInterface</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_factory</span> <span class="o">=</span> <span class="n">element_factory</span>
+
+ <span class="c">##</span>
+ <span class="c"># Flushes the parser buffers, and returns the toplevel documen</span>
+ <span class="c"># element.</span>
+ <span class="c">#</span>
+ <span class="c"># @return An Element instance.</span>
+ <span class="c"># @defreturn Element</span>
+
+<div class="viewcode-block" id="TreeBuilder.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.TreeBuilder.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">,</span> <span class="s">"missing end tags"</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">,</span> <span class="s">"missing toplevel element"</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span>
+</div>
+ <span class="k">def</span> <span class="nf">_flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">+=</span> <span class="n">item</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">+=</span> <span class="n">item</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tail</span><span class="p">:</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">tail</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">,</span> <span class="s">"internal error (tail)"</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">tail</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">text</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">,</span> <span class="s">"internal error (text)"</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_data</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="c">##</span>
+ <span class="c"># Adds text to the current element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param data A string. This should be either an 8-bit string</span>
+ <span class="c"># containing ASCII text, or a Unicode string.</span>
+
+<div class="viewcode-block" id="TreeBuilder.data"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.TreeBuilder.data">[docs]</a> <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Opens a new element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param tag The element name.</span>
+ <span class="c"># @param attrib A dictionary containing element attributes.</span>
+ <span class="c"># @return The opened element.</span>
+ <span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="TreeBuilder.start"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.TreeBuilder.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_flush</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span> <span class="o">=</span> <span class="n">elem</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_factory</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrs</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_elem</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_elem</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_tail</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">return</span> <span class="n">elem</span>
+
+ <span class="c">##</span>
+ <span class="c"># Closes the current element.</span>
+ <span class="c">#</span>
+ <span class="c"># @param tag The element name.</span>
+ <span class="c"># @return The closed element.</span>
+ <span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="TreeBuilder.end"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.TreeBuilder.end">[docs]</a> <span class="k">def</span> <span class="nf">end</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_flush</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">tag</span><span class="p">,</span>\
+ <span class="s">"end tag mismatch (expected </span><span class="si">%s</span><span class="s">, got </span><span class="si">%s</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_last</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">tag</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_tail</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last</span>
+
+<span class="c">##</span>
+<span class="c"># Element structure builder for XML source data, based on the</span>
+<span class="c"># <b>expat</b> parser.</span>
+<span class="c">#</span>
+<span class="c"># @keyparam target Target object. If omitted, the builder uses an</span>
+<span class="c"># instance of the standard {@link #TreeBuilder} class.</span>
+<span class="c"># @keyparam html Predefine HTML entities. This flag is not supported</span>
+<span class="c"># by the current implementation.</span>
+<span class="c"># @see #ElementTree</span>
+<span class="c"># @see #TreeBuilder</span>
+</div></div>
+<div class="viewcode-block" id="XMLTreeBuilder"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder">[docs]</a><span class="k">class</span> <span class="nc">XMLTreeBuilder</span><span class="p">:</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">html</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="kn">from</span> <span class="nn">xml.parsers</span> <span class="kn">import</span> <span class="n">expat</span>
+ <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
+ <span class="s">"No module named expat; use SimpleXMLTreeBuilder instead"</span>
+ <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span> <span class="o">=</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">expat</span><span class="o">.</span><span class="n">ParserCreate</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">"}"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">target</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">target</span> <span class="o">=</span> <span class="n">TreeBuilder</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_target</span> <span class="o">=</span> <span class="n">target</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_names</span> <span class="o">=</span> <span class="p">{}</span> <span class="c"># name memo cache</span>
+ <span class="c"># callbacks</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">DefaultHandlerExpand</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">StartElementHandler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">EndElementHandler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_end</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">CharacterDataHandler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span>
+ <span class="c"># let expat do the buffering, if supported</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">buffer_text</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="c"># use new-style attribute handling, if supported</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">ordered_attributes</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">specified_attributes</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">StartElementHandler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_list</span>
+ <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="c">#encoding = None</span>
+ <span class="c">#if not parser.returns_unicode:</span>
+ <span class="c"># encoding = "utf-8"</span>
+ <span class="c"># target.xml(encoding, None)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">entity</span> <span class="o">=</span> <span class="p">{}</span>
+
+ <span class="k">def</span> <span class="nf">_fixtext</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="c"># convert text string to ascii, if possible</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_encode</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"ascii"</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">text</span>
+
+ <span class="k">def</span> <span class="nf">_fixname</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="c"># expand qname, and convert name string to ascii, if possible</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_names</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
+ <span class="n">name</span> <span class="o">=</span> <span class="n">key</span>
+ <span class="k">if</span> <span class="s">"}"</span> <span class="ow">in</span> <span class="n">name</span><span class="p">:</span>
+ <span class="n">name</span> <span class="o">=</span> <span class="s">"{"</span> <span class="o">+</span> <span class="n">name</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_names</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fixtext</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">name</span>
+
+ <span class="k">def</span> <span class="nf">_start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">):</span>
+ <span class="n">fixname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fixname</span>
+ <span class="n">tag</span> <span class="o">=</span> <span class="n">fixname</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">attrib_in</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
+ <span class="n">attrib</span><span class="p">[</span><span class="n">fixname</span><span class="p">(</span><span class="n">key</span><span class="p">)]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fixtext</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">_start_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib_in</span><span class="p">):</span>
+ <span class="n">fixname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fixname</span>
+ <span class="n">tag</span> <span class="o">=</span> <span class="n">fixname</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">if</span> <span class="n">attrib_in</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">attrib_in</span><span class="p">),</span> <span class="mi">2</span><span class="p">):</span>
+ <span class="n">attrib</span><span class="p">[</span><span class="n">fixname</span><span class="p">(</span><span class="n">attrib_in</span><span class="p">[</span><span class="n">i</span><span class="p">])]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fixtext</span><span class="p">(</span><span class="n">attrib_in</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fixtext</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">_end</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fixname</span><span class="p">(</span><span class="n">tag</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">_default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="n">text</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">prefix</span> <span class="o">==</span> <span class="s">"&"</span><span class="p">:</span>
+ <span class="c"># deal with undefined entities</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entity</span><span class="p">[</span><span class="n">text</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
+ <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
+ <span class="kn">from</span> <span class="nn">xml.parsers</span> <span class="kn">import</span> <span class="n">expat</span>
+ <span class="k">raise</span> <span class="n">expat</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
+ <span class="s">"undefined entity </span><span class="si">%s</span><span class="s">: line </span><span class="si">%d</span><span class="s">, column </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span>
+ <span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">ErrorLineNumber</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">ErrorColumnNumber</span><span class="p">)</span>
+ <span class="p">)</span>
+ <span class="k">elif</span> <span class="n">prefix</span> <span class="o">==</span> <span class="s">"<"</span> <span class="ow">and</span> <span class="n">text</span><span class="p">[:</span><span class="mi">9</span><span class="p">]</span> <span class="o">==</span> <span class="s">"<!DOCTYPE"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># inside a doctype declaration</span>
+ <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="c"># parse doctype contents</span>
+ <span class="k">if</span> <span class="n">prefix</span> <span class="o">==</span> <span class="s">">"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">return</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">text</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="n">n</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">n</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
+ <span class="nb">type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">type</span> <span class="o">==</span> <span class="s">"PUBLIC"</span> <span class="ow">and</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
+ <span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">pubid</span><span class="p">,</span> <span class="n">system</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span>
+ <span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="s">"SYSTEM"</span> <span class="ow">and</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
+ <span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">system</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span>
+ <span class="n">pubid</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="k">if</span> <span class="n">pubid</span><span class="p">:</span>
+ <span class="n">pubid</span> <span class="o">=</span> <span class="n">pubid</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">doctype</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">pubid</span><span class="p">,</span> <span class="n">system</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_doctype</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c">##</span>
+ <span class="c"># Handles a doctype declaration.</span>
+ <span class="c">#</span>
+ <span class="c"># @param name Doctype name.</span>
+ <span class="c"># @param pubid Public identifier.</span>
+ <span class="c"># @param system System identifier.</span>
+
+<div class="viewcode-block" id="XMLTreeBuilder.doctype"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.doctype">[docs]</a> <span class="k">def</span> <span class="nf">doctype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">pubid</span><span class="p">,</span> <span class="n">system</span><span class="p">):</span>
+ <span class="k">pass</span>
+
+ <span class="c">##</span>
+ <span class="c"># Feeds data to the parser.</span>
+ <span class="c">#</span>
+ <span class="c"># @param data Encoded data.</span>
+</div>
+<div class="viewcode-block" id="XMLTreeBuilder.feed"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.feed">[docs]</a> <span class="k">def</span> <span class="nf">feed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
+ <span class="c"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
+ <span class="c"># de remontee de log des tests</span>
+ <span class="c">#print "TRACES OP - ElementTree.py/XMLTreeBuilder.feed() data = '#%s#'" %data</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">Parse</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Finishes feeding data to the parser.</span>
+ <span class="c">#</span>
+ <span class="c"># @return An element structure.</span>
+ <span class="c"># @defreturn Element</span>
+</div>
+<div class="viewcode-block" id="XMLTreeBuilder.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">Parse</span><span class="p">(</span><span class="s">""</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c"># end of data</span>
+ <span class="n">tree</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parser</span> <span class="c"># get rid of circular references</span>
+ <span class="k">return</span> <span class="n">tree</span></div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.__init__ — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.__init__</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+
+<span class="sd">"""\</span>
+<span class="sd">initial imports and utilities methods for salomeTools</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">shutil</span>
+<span class="kn">import</span> <span class="nn">errno</span>
+<span class="kn">import</span> <span class="nn">stat</span>
+
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">pyconf</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">architecture</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">printcolors</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">options</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">system</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">ElementTree</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">logger</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">product</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">environment</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">fileEnviron</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">compilation</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">test_module</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">template</span>
+
+<span class="kn">import</span> <span class="nn">platform</span>
+<span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s">"Windows"</span> <span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">colorama</span>
+ <span class="n">colorama</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
+
+<span class="n">OK_STATUS</span> <span class="o">=</span> <span class="s">"OK"</span>
+<span class="n">KO_STATUS</span> <span class="o">=</span> <span class="s">"KO"</span>
+<span class="n">NA_STATUS</span> <span class="o">=</span> <span class="s">"NA"</span>
+<span class="n">KNOWNFAILURE_STATUS</span> <span class="o">=</span> <span class="s">"KF"</span>
+<span class="n">TIMEOUT_STATUS</span> <span class="o">=</span> <span class="s">"TIMEOUT"</span>
+
+<span class="n">CONFIG_FILENAME</span> <span class="o">=</span> <span class="s">"sat-config.pyconf"</span>
+
+<div class="viewcode-block" id="SatException"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.SatException">[docs]</a><span class="k">class</span> <span class="nc">SatException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+ <span class="sd">"""rename Exception Class"""</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ensure_path_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.ensure_path_exists">[docs]</a><span class="k">def</span> <span class="nf">ensure_path_exists</span><span class="p">(</span><span class="n">p</span><span class="p">):</span>
+ <span class="sd">"""Create a path if not existing</span>
+<span class="sd"> </span>
+<span class="sd"> :param p str: The path.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">p</span><span class="p">):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="check_config_has_application"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.check_config_has_application">[docs]</a><span class="k">def</span> <span class="nf">check_config_has_application</span><span class="p">(</span> <span class="n">config</span><span class="p">,</span> <span class="n">details</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">"""check that the config has the key APPLICATION. Else raise an exception.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'common.pyconf.Config': The config.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'APPLICATION'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span>
+ <span class="n">message</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"An APPLICATION is required. Use 'config --list' to get"</span>
+ <span class="s">" the list of available applications.</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">details</span> <span class="p">:</span>
+ <span class="n">details</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span> <span class="n">message</span> <span class="p">)</span>
+</div>
+<div class="viewcode-block" id="check_config_has_profile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.check_config_has_profile">[docs]</a><span class="k">def</span> <span class="nf">check_config_has_profile</span><span class="p">(</span> <span class="n">config</span><span class="p">,</span> <span class="n">details</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> check that the config has the key APPLICATION.profile.</span>
+<span class="sd"> else, raise an exception.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'common.pyconf.Config': The config.</span>
+<span class="sd"> """</span>
+ <span class="n">check_config_has_application</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s">'profile'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
+ <span class="n">message</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"A profile section is required in your application.</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">details</span> <span class="p">:</span>
+ <span class="n">details</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span> <span class="n">message</span> <span class="p">)</span>
+</div>
+<div class="viewcode-block" id="config_has_application"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.config_has_application">[docs]</a><span class="k">def</span> <span class="nf">config_has_application</span><span class="p">(</span> <span class="n">config</span> <span class="p">):</span>
+ <span class="k">return</span> <span class="s">'APPLICATION'</span> <span class="ow">in</span> <span class="n">config</span>
+</div>
+<div class="viewcode-block" id="get_cfg_param"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_cfg_param">[docs]</a><span class="k">def</span> <span class="nf">get_cfg_param</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">default</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> eearch for param_name value in config.</span>
+<span class="sd"> if param_name is not in config </span>
+<span class="sd"> then return default,</span>
+<span class="sd"> else return the found value</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'common.pyconf.Config': The config.</span>
+<span class="sd"> :param param_name str: the name of the parameter to get the value</span>
+<span class="sd"> :param default str: The value to return if param_name is not in config</span>
+<span class="sd"> :return: see initial description of the function</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">param_name</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">config</span><span class="p">[</span><span class="n">param_name</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">default</span>
+</div>
+<div class="viewcode-block" id="print_info"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.print_info">[docs]</a><span class="k">def</span> <span class="nf">print_info</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Prints the tuples that are in info variable in a formatted way.</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logging instance to use for the prints.</span>
+<span class="sd"> :param info list: The list of tuples to display</span>
+<span class="sd"> """</span>
+ <span class="c"># find the maximum length of the first value of the tuples in info</span>
+ <span class="n">smax</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> <span class="n">info</span><span class="p">))</span>
+ <span class="c"># Print each item of info with good indentation</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">info</span><span class="p">:</span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="s">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">smax</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">i</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
+ <span class="n">printcolors</span><span class="o">.</span><span class="n">print_value</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">sp</span> <span class="o">+</span> <span class="n">i</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">i</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="get_base_path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_base_path">[docs]</a><span class="k">def</span> <span class="nf">get_base_path</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Returns the path of the products base.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global Config instance.</span>
+<span class="sd"> :return: The path of the products base.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">"base"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">LOCAL</span><span class="p">:</span>
+ <span class="n">local_file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">salometoolsway</span><span class="p">,</span>
+ <span class="s">"data"</span><span class="p">,</span>
+ <span class="s">"local.pyconf"</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Please define a base path in the file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">local_file_path</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="n">base_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">base</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">base_path</span>
+</div>
+<div class="viewcode-block" id="get_launcher_name"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_launcher_name">[docs]</a><span class="k">def</span> <span class="nf">get_launcher_name</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Returns the name of salome launcher.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global Config instance.</span>
+<span class="sd"> :return: The name of salome launcher.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="n">check_config_has_application</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s">'profile'</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span> <span class="ow">and</span> <span class="s">'launcher_name'</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">profile</span><span class="p">:</span>
+ <span class="n">launcher_name</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">launcher_name</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">launcher_name</span> <span class="o">=</span> <span class="s">'salome'</span>
+
+ <span class="k">return</span> <span class="n">launcher_name</span>
+</div>
+<div class="viewcode-block" id="get_log_path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_log_path">[docs]</a><span class="k">def</span> <span class="nf">get_log_path</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Returns the path of the logs.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global Config instance.</span>
+<span class="sd"> :return: The path of the logs.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">"log_dir"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">LOCAL</span><span class="p">:</span>
+ <span class="n">local_file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">salometoolsway</span><span class="p">,</span>
+ <span class="s">"data"</span><span class="p">,</span>
+ <span class="s">"local.pyconf"</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Please define a log_dir in the file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">local_file_path</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="n">log_dir_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">log_dir</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">log_dir_path</span>
+</div>
+<div class="viewcode-block" id="get_salome_version"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_salome_version">[docs]</a><span class="k">def</span> <span class="nf">get_salome_version</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">,</span> <span class="s">'version_salome'</span><span class="p">):</span>
+ <span class="n">Version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">version_salome</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">KERNEL_info</span> <span class="o">=</span> <span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"KERNEL"</span><span class="p">)</span>
+ <span class="n">VERSION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="n">KERNEL_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">,</span>
+ <span class="s">"bin"</span><span class="p">,</span>
+ <span class="s">"salome"</span><span class="p">,</span>
+ <span class="s">"VERSION"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">VERSION</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">None</span>
+
+ <span class="n">fVERSION</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">VERSION</span><span class="p">)</span>
+ <span class="n">Version</span> <span class="o">=</span> <span class="n">fVERSION</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
+ <span class="n">fVERSION</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="n">VersionSalome</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">Version</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">VersionSalome</span>
+</div>
+<div class="viewcode-block" id="only_numbers"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.only_numbers">[docs]</a><span class="k">def</span> <span class="nf">only_numbers</span><span class="p">(</span><span class="n">str_num</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">nb</span> <span class="k">for</span> <span class="n">nb</span> <span class="ow">in</span> <span class="n">str_num</span> <span class="k">if</span> <span class="n">nb</span> <span class="ow">in</span> <span class="s">'0123456789'</span><span class="p">]</span> <span class="ow">or</span> <span class="s">'0'</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="read_config_from_a_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.read_config_from_a_file">[docs]</a><span class="k">def</span> <span class="nf">read_config_from_a_file</span><span class="p">(</span><span class="n">filePath</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">cfg_file</span> <span class="o">=</span> <span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">filePath</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">pyconf</span><span class="o">.</span><span class="n">ConfigError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Error in configuration file: </span><span class="si">%(file)s</span><span class="se">\n</span><span class="s"> </span><span class="si">%(error)s</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'file'</span><span class="p">:</span> <span class="n">filePath</span><span class="p">,</span> <span class="s">'error'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="p">})</span>
+ <span class="k">return</span> <span class="n">cfg_file</span>
+</div>
+<div class="viewcode-block" id="get_tmp_filename"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_tmp_filename">[docs]</a><span class="k">def</span> <span class="nf">get_tmp_filename</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+
+<span class="c">##</span>
+<span class="c"># Utils class to simplify path manipulations.</span></div>
+<div class="viewcode-block" id="Path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path">[docs]</a><span class="k">class</span> <span class="nc">Path</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__add__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">other</span><span class="p">)))</span>
+
+ <span class="k">def</span> <span class="nf">__abs__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span>
+
+ <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">path</span>
+
+<div class="viewcode-block" id="Path.exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.exists">[docs]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">()</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.islink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.islink">[docs]</a> <span class="k">def</span> <span class="nf">islink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.isdir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.isdir">[docs]</a> <span class="k">def</span> <span class="nf">isdir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.isfile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.isfile">[docs]</a> <span class="k">def</span> <span class="nf">isfile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="p">[</span><span class="n">Path</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)]</span>
+</div>
+<div class="viewcode-block" id="Path.dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.dir">[docs]</a> <span class="k">def</span> <span class="nf">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="Path.base"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.base">[docs]</a> <span class="k">def</span> <span class="nf">base</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="Path.make"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.make">[docs]</a> <span class="k">def</span> <span class="nf">make</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mode</span><span class="p">:</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="Path.chmod"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.chmod">[docs]</a> <span class="k">def</span> <span class="nf">chmod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="p">):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.rm"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.rm">[docs]</a> <span class="k">def</span> <span class="nf">rm</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">():</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">onerror</span> <span class="o">=</span> <span class="n">handleRemoveReadonly</span> <span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.copy"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">smart</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">Path</span><span class="p">):</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">copylink</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">copydir</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">smart</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">copyfile</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.smartcopy"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.smartcopy">[docs]</a> <span class="k">def</span> <span class="nf">smartcopy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Path.readlink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.readlink">[docs]</a> <span class="k">def</span> <span class="nf">readlink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="Path.symlink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.symlink">[docs]</a> <span class="k">def</span> <span class="nf">symlink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">symlink</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="Path.copylink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.copylink">[docs]</a> <span class="k">def</span> <span class="nf">copylink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">symlink</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="Path.copydir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.copydir">[docs]</a> <span class="k">def</span> <span class="nf">copydir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span> <span class="n">smart</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">names</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">dst</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+ <span class="n">dst</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
+
+ <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="n">dst</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">smart</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="s">".git"</span><span class="p">,</span> <span class="s">"CVS"</span><span class="p">,</span> <span class="s">".svn"</span><span class="p">]):</span>
+ <span class="k">continue</span>
+ <span class="n">srcname</span> <span class="o">=</span> <span class="bp">self</span> <span class="o">+</span> <span class="n">name</span>
+ <span class="n">dstname</span> <span class="o">=</span> <span class="n">dst</span> <span class="o">+</span> <span class="n">name</span>
+ <span class="n">srcname</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">dstname</span><span class="p">,</span> <span class="n">smart</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="Path.copyfile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.copyfile">[docs]</a> <span class="k">def</span> <span class="nf">copyfile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">copy2</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div></div>
+<div class="viewcode-block" id="find_file_in_lpath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.find_file_in_lpath">[docs]</a><span class="k">def</span> <span class="nf">find_file_in_lpath</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">lpath</span><span class="p">,</span> <span class="n">additional_dir</span> <span class="o">=</span> <span class="s">""</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Find in all the directories in lpath list the file that has the same name</span>
+<span class="sd"> as file_name. </span>
+<span class="sd"> If it is found </span>
+<span class="sd"> then return the full path of the file</span>
+<span class="sd"> else return False.</span>
+<span class="sd"> </span>
+<span class="sd"> The additional_dir (optional) is the name of the directory to add to all </span>
+<span class="sd"> paths in lpath.</span>
+<span class="sd"> </span>
+<span class="sd"> :param file_name str: The file name to search</span>
+<span class="sd"> :param lpath List: The list of directories where to search</span>
+<span class="sd"> :param additional_dir str: The name of the additional directory</span>
+<span class="sd"> :return: the full path of the file or False if not found</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">for</span> <span class="n">directory</span> <span class="ow">in</span> <span class="n">lpath</span><span class="p">:</span>
+ <span class="n">dir_complete</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="n">additional_dir</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">directory</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">dir_complete</span><span class="p">):</span>
+ <span class="k">continue</span>
+ <span class="n">l_files</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dir_complete</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">file_n</span> <span class="ow">in</span> <span class="n">l_files</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">file_n</span> <span class="o">==</span> <span class="n">file_name</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dir_complete</span><span class="p">,</span> <span class="n">file_name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="handleRemoveReadonly"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.handleRemoveReadonly">[docs]</a><span class="k">def</span> <span class="nf">handleRemoveReadonly</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">exc</span><span class="p">):</span>
+ <span class="n">excvalue</span> <span class="o">=</span> <span class="n">exc</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">func</span> <span class="ow">in</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">rmdir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">)</span> <span class="ow">and</span> <span class="n">excvalue</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">EACCES</span><span class="p">:</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXU</span><span class="o">|</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXG</span><span class="o">|</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXO</span><span class="p">)</span> <span class="c"># 0777</span>
+ <span class="n">func</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span>
+</div>
+<div class="viewcode-block" id="deepcopy_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.deepcopy_list">[docs]</a><span class="k">def</span> <span class="nf">deepcopy_list</span><span class="p">(</span><span class="n">input_list</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Do a deep copy of a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param input_list List: The list to copy</span>
+<span class="sd"> :return: The copy of the list</span>
+<span class="sd"> :rtype: List</span>
+<span class="sd"> """</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">input_list</span><span class="p">:</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="remove_item_from_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.remove_item_from_list">[docs]</a><span class="k">def</span> <span class="nf">remove_item_from_list</span><span class="p">(</span><span class="n">input_list</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Remove all occurences of item from input_list</span>
+<span class="sd"> </span>
+<span class="sd"> :param input_list List: The list to modify</span>
+<span class="sd"> :return: The without any item</span>
+<span class="sd"> :rtype: List</span>
+<span class="sd"> """</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">input_list</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">elem</span> <span class="o">==</span> <span class="n">item</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="parse_date"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.parse_date">[docs]</a><span class="k">def</span> <span class="nf">parse_date</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.</span>
+<span class="sd"> </span>
+<span class="sd"> :param date str: The date to transform</span>
+<span class="sd"> :return: The date in the new format</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">date</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">15</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">date</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">-</span><span class="si">%s</span><span class="s">-</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">date</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">4</span><span class="p">],</span>
+ <span class="n">date</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">],</span>
+ <span class="n">date</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">],</span>
+ <span class="n">date</span><span class="p">[</span><span class="mi">9</span><span class="p">:</span><span class="mi">11</span><span class="p">],</span>
+ <span class="n">date</span><span class="p">[</span><span class="mi">11</span><span class="p">:</span><span class="mi">13</span><span class="p">],</span>
+ <span class="n">date</span><span class="p">[</span><span class="mi">13</span><span class="p">:])</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="merge_dicts"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.merge_dicts">[docs]</a><span class="k">def</span> <span class="nf">merge_dicts</span><span class="p">(</span><span class="o">*</span><span class="n">dict_args</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Given any number of dicts, shallow copy and merge into a new dict,</span>
+<span class="sd"> precedence goes to key value pairs in latter dicts.</span>
+<span class="sd"> """</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">dictionary</span> <span class="ow">in</span> <span class="n">dict_args</span><span class="p">:</span>
+ <span class="n">result</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">dictionary</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">result</span>
+</div>
+<div class="viewcode-block" id="replace_in_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.replace_in_file">[docs]</a><span class="k">def</span> <span class="nf">replace_in_file</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="n">strin</span><span class="p">,</span> <span class="n">strout</span><span class="p">):</span>
+ <span class="sd">"""Replace <strin> by <strout> in file <filein>"""</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="n">filein</span> <span class="o">+</span> <span class="s">"_old"</span><span class="p">)</span>
+ <span class="n">fileout</span><span class="o">=</span> <span class="n">filein</span>
+ <span class="n">filein</span> <span class="o">=</span> <span class="n">filein</span> <span class="o">+</span> <span class="s">"_old"</span>
+ <span class="n">fin</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span>
+ <span class="n">fout</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fileout</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">fin</span><span class="p">:</span>
+ <span class="n">fout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">strin</span><span class="p">,</span> <span class="n">strout</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="get_property_in_product_cfg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.get_property_in_product_cfg">[docs]</a><span class="k">def</span> <span class="nf">get_property_in_product_cfg</span><span class="p">(</span><span class="n">product_cfg</span><span class="p">,</span> <span class="n">pprty</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_cfg</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">pprty</span> <span class="ow">in</span> <span class="n">product_cfg</span><span class="o">.</span><span class="n">properties</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">None</span>
+ <span class="k">return</span> <span class="n">product_cfg</span><span class="o">.</span><span class="n">properties</span><span class="p">[</span><span class="n">pprty</span><span class="p">]</span>
+</div>
+<div class="viewcode-block" id="activate_mesa_property"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.activate_mesa_property">[docs]</a><span class="k">def</span> <span class="nf">activate_mesa_property</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""Add mesa property into application properties</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration. It must have an application!</span>
+<span class="sd"> """</span>
+ <span class="c"># Verify the existence of the file</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">'properties'</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span> <span class="s">'properties'</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(),</span> <span class="bp">None</span> <span class="p">)</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">use_mesa</span><span class="o">=</span><span class="s">"yes"</span>
+</pre></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.architecture — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.architecture</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="sd">'''</span>
+<span class="sd">In this file : all the stuff that can change with the architecture </span>
+<span class="sd">on which SAT is running</span>
+<span class="sd">'''</span>
+
+<span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">platform</span>
+
+<div class="viewcode-block" id="is_windows"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.is_windows">[docs]</a><span class="k">def</span> <span class="nf">is_windows</span><span class="p">():</span>
+ <span class="sd">'''method that checks windows OS</span>
+<span class="sd"> </span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s">'Windows'</span>
+</div>
+<div class="viewcode-block" id="get_user"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.get_user">[docs]</a><span class="k">def</span> <span class="nf">get_user</span><span class="p">():</span>
+ <span class="sd">'''method that gets the username that launched sat </span>
+<span class="sd"> </span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="c"># In windows case, the USERNAME environment variable has to be set</span>
+ <span class="k">if</span> <span class="n">is_windows</span><span class="p">():</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s">'USERNAME'</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'USERNAME environment variable not set'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'USERNAME'</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span> <span class="c"># linux</span>
+ <span class="kn">import</span> <span class="nn">pwd</span>
+ <span class="k">return</span> <span class="n">pwd</span><span class="o">.</span><span class="n">getpwuid</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getuid</span><span class="p">())[</span><span class="mi">0</span><span class="p">]</span>
+</div>
+<span class="k">def</span> <span class="nf">_lsb_release</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
+ <span class="sd">'''Get system information with lsb_release.</span>
+<span class="sd"> </span>
+<span class="sd"> :param args str: The arguments to give to lsb_release.</span>
+<span class="sd"> :return: The distribution.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="s">'/usr/local/bin:/usr/bin:/bin'</span>
+ <span class="n">lsb_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s">"LSB_PATH"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">lsb_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="n">lsb_path</span> <span class="o">+</span> <span class="s">":"</span> <span class="o">+</span> <span class="n">path</span>
+
+ <span class="kn">from</span> <span class="nn">subprocess</span> <span class="kn">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">Popen</span><span class="p">([</span><span class="s">'lsb_release'</span><span class="p">,</span> <span class="n">args</span><span class="p">],</span> <span class="n">env</span><span class="o">=</span><span class="p">{</span><span class="s">'PATH'</span><span class="p">:</span> <span class="n">path</span><span class="p">},</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()[</span><span class="mi">0</span><span class="p">][:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="c"># in case of python3, convert byte to str</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">u"lsb_release not installed</span><span class="se">\n</span><span class="s">"</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">u"You can define $LSB_PATH to give"</span>
+ <span class="s">" the path to lsb_release</span><span class="se">\n</span><span class="s">"</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
+
+<div class="viewcode-block" id="get_distribution"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.get_distribution">[docs]</a><span class="k">def</span> <span class="nf">get_distribution</span><span class="p">(</span><span class="n">codes</span><span class="p">):</span>
+ <span class="sd">'''Gets the code for the distribution</span>
+<span class="sd"> </span>
+<span class="sd"> :param codes L{Mapping}: The map containing distribution correlation table.</span>
+<span class="sd"> :return: The distribution on which salomeTools is running, regarding the </span>
+<span class="sd"> distribution correlation table contained in codes variable.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="n">is_windows</span><span class="p">():</span>
+ <span class="k">return</span> <span class="s">"Win"</span>
+
+ <span class="c"># Call to lsb_release</span>
+ <span class="n">distrib</span> <span class="o">=</span> <span class="n">_lsb_release</span><span class="p">(</span><span class="s">'-si'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">codes</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">distrib</span> <span class="ow">in</span> <span class="n">codes</span><span class="p">:</span>
+ <span class="n">distrib</span> <span class="o">=</span> <span class="n">codes</span><span class="p">[</span><span class="n">distrib</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">u"Unknown distribution: '</span><span class="si">%s</span><span class="s">'</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">distrib</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">u"Please add your distribution to"</span>
+ <span class="s">" src/internal_config/distrib.pyconf</span><span class="se">\n</span><span class="s">"</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">distrib</span>
+
+</div>
+<div class="viewcode-block" id="get_distrib_version"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.get_distrib_version">[docs]</a><span class="k">def</span> <span class="nf">get_distrib_version</span><span class="p">(</span><span class="n">distrib</span><span class="p">,</span> <span class="n">codes</span><span class="p">):</span>
+ <span class="sd">'''Gets the version of the distribution</span>
+<span class="sd"> </span>
+<span class="sd"> :param distrib str: The distribution on which the version will be found.</span>
+<span class="sd"> :param codes L{Mapping}: The map containing distribution correlation table.</span>
+<span class="sd"> :return: The version of the distribution on which salomeTools is running, </span>
+<span class="sd"> regarding the distribution correlation table contained in codes </span>
+<span class="sd"> variable.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+
+ <span class="k">if</span> <span class="n">is_windows</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
+
+ <span class="c"># Call to lsb_release</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">_lsb_release</span><span class="p">(</span><span class="s">'-sr'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">distrib</span> <span class="ow">in</span> <span class="n">codes</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">version</span> <span class="ow">in</span> <span class="n">codes</span><span class="p">[</span><span class="n">distrib</span><span class="p">]:</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">codes</span><span class="p">[</span><span class="n">distrib</span><span class="p">][</span><span class="n">version</span><span class="p">]</span>
+
+ <span class="k">if</span> <span class="n">distrib</span> <span class="o">==</span> <span class="s">"CO"</span><span class="p">:</span>
+ <span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c">#for centos, we only care for major version</span>
+ <span class="k">return</span> <span class="n">version</span>
+</div>
+<div class="viewcode-block" id="get_python_version"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.get_python_version">[docs]</a><span class="k">def</span> <span class="nf">get_python_version</span><span class="p">():</span>
+ <span class="sd">'''Gets the version of the running python.</span>
+<span class="sd"> </span>
+<span class="sd"> :return: the version of the running python.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+
+ <span class="c"># The platform python module gives the answer</span>
+ <span class="k">return</span> <span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="get_nb_proc"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.get_nb_proc">[docs]</a><span class="k">def</span> <span class="nf">get_nb_proc</span><span class="p">():</span>
+ <span class="sd">'''Gets the number of processors of the machine </span>
+<span class="sd"> on which salomeTools is running.</span>
+<span class="sd"> </span>
+<span class="sd"> :return: the number of processors.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+
+ <span class="k">try</span> <span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">multiprocessing</span>
+ <span class="n">nb_proc</span><span class="o">=</span><span class="n">multiprocessing</span><span class="o">.</span><span class="n">cpu_count</span><span class="p">()</span>
+ <span class="k">except</span> <span class="p">:</span>
+ <span class="n">nb_proc</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">sysconf</span><span class="p">(</span><span class="s">'SC_NPROCESSORS_ONLN'</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">nb_proc</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.colorama.ansi — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.colorama.ansi</h1><div class="highlight"><pre>
+<span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
+<span class="sd">'''</span>
+<span class="sd">This module generates ANSI character codes to printing colors to terminals.</span>
+<span class="sd">See: http://en.wikipedia.org/wiki/ANSI_escape_code</span>
+<span class="sd">'''</span>
+
+<span class="n">CSI</span> <span class="o">=</span> <span class="s">'</span><span class="se">\033</span><span class="s">['</span>
+<span class="n">OSC</span> <span class="o">=</span> <span class="s">'</span><span class="se">\033</span><span class="s">]'</span>
+<span class="n">BEL</span> <span class="o">=</span> <span class="s">'</span><span class="se">\007</span><span class="s">'</span>
+
+
+<div class="viewcode-block" id="code_to_chars"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.code_to_chars">[docs]</a><span class="k">def</span> <span class="nf">code_to_chars</span><span class="p">(</span><span class="n">code</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">code</span><span class="p">)</span> <span class="o">+</span> <span class="s">'m'</span>
+</div>
+<div class="viewcode-block" id="set_title"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.set_title">[docs]</a><span class="k">def</span> <span class="nf">set_title</span><span class="p">(</span><span class="n">title</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">OSC</span> <span class="o">+</span> <span class="s">'2;'</span> <span class="o">+</span> <span class="n">title</span> <span class="o">+</span> <span class="n">BEL</span>
+</div>
+<div class="viewcode-block" id="clear_screen"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.clear_screen">[docs]</a><span class="k">def</span> <span class="nf">clear_screen</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">mode</span><span class="p">)</span> <span class="o">+</span> <span class="s">'J'</span>
+</div>
+<div class="viewcode-block" id="clear_line"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.clear_line">[docs]</a><span class="k">def</span> <span class="nf">clear_line</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">mode</span><span class="p">)</span> <span class="o">+</span> <span class="s">'K'</span>
+
+</div>
+<div class="viewcode-block" id="AnsiCodes"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCodes">[docs]</a><span class="k">class</span> <span class="nc">AnsiCodes</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c"># the subclasses declare class attributes which are numbers.</span>
+ <span class="c"># Upon instantiation we define instance attributes, which are the same</span>
+ <span class="c"># as the class attributes but wrapped with the ANSI escape sequence</span>
+ <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'_'</span><span class="p">):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+ <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">code_to_chars</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
+
+</div>
+<div class="viewcode-block" id="AnsiCursor"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor">[docs]</a><span class="k">class</span> <span class="nc">AnsiCursor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+<div class="viewcode-block" id="AnsiCursor.UP"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.UP">[docs]</a> <span class="k">def</span> <span class="nf">UP</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">'A'</span></div>
+<div class="viewcode-block" id="AnsiCursor.DOWN"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.DOWN">[docs]</a> <span class="k">def</span> <span class="nf">DOWN</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">'B'</span></div>
+<div class="viewcode-block" id="AnsiCursor.FORWARD"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.FORWARD">[docs]</a> <span class="k">def</span> <span class="nf">FORWARD</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">'C'</span></div>
+<div class="viewcode-block" id="AnsiCursor.BACK"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.BACK">[docs]</a> <span class="k">def</span> <span class="nf">BACK</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">'D'</span></div>
+<div class="viewcode-block" id="AnsiCursor.POS"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.POS">[docs]</a> <span class="k">def</span> <span class="nf">POS</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">+</span> <span class="s">';'</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="s">'H'</span>
+
+</div></div>
+<div class="viewcode-block" id="AnsiFore"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore">[docs]</a><span class="k">class</span> <span class="nc">AnsiFore</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
+ <span class="n">BLACK</span> <span class="o">=</span> <span class="mi">30</span>
+ <span class="n">RED</span> <span class="o">=</span> <span class="mi">31</span>
+ <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">32</span>
+ <span class="n">YELLOW</span> <span class="o">=</span> <span class="mi">33</span>
+ <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">34</span>
+ <span class="n">MAGENTA</span> <span class="o">=</span> <span class="mi">35</span>
+ <span class="n">CYAN</span> <span class="o">=</span> <span class="mi">36</span>
+ <span class="n">WHITE</span> <span class="o">=</span> <span class="mi">37</span>
+ <span class="n">RESET</span> <span class="o">=</span> <span class="mi">39</span>
+
+ <span class="c"># These are fairly well supported, but not part of the standard.</span>
+ <span class="n">LIGHTBLACK_EX</span> <span class="o">=</span> <span class="mi">90</span>
+ <span class="n">LIGHTRED_EX</span> <span class="o">=</span> <span class="mi">91</span>
+ <span class="n">LIGHTGREEN_EX</span> <span class="o">=</span> <span class="mi">92</span>
+ <span class="n">LIGHTYELLOW_EX</span> <span class="o">=</span> <span class="mi">93</span>
+ <span class="n">LIGHTBLUE_EX</span> <span class="o">=</span> <span class="mi">94</span>
+ <span class="n">LIGHTMAGENTA_EX</span> <span class="o">=</span> <span class="mi">95</span>
+ <span class="n">LIGHTCYAN_EX</span> <span class="o">=</span> <span class="mi">96</span>
+ <span class="n">LIGHTWHITE_EX</span> <span class="o">=</span> <span class="mi">97</span>
+
+</div>
+<div class="viewcode-block" id="AnsiBack"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack">[docs]</a><span class="k">class</span> <span class="nc">AnsiBack</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
+ <span class="n">BLACK</span> <span class="o">=</span> <span class="mi">40</span>
+ <span class="n">RED</span> <span class="o">=</span> <span class="mi">41</span>
+ <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">42</span>
+ <span class="n">YELLOW</span> <span class="o">=</span> <span class="mi">43</span>
+ <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">44</span>
+ <span class="n">MAGENTA</span> <span class="o">=</span> <span class="mi">45</span>
+ <span class="n">CYAN</span> <span class="o">=</span> <span class="mi">46</span>
+ <span class="n">WHITE</span> <span class="o">=</span> <span class="mi">47</span>
+ <span class="n">RESET</span> <span class="o">=</span> <span class="mi">49</span>
+
+ <span class="c"># These are fairly well supported, but not part of the standard.</span>
+ <span class="n">LIGHTBLACK_EX</span> <span class="o">=</span> <span class="mi">100</span>
+ <span class="n">LIGHTRED_EX</span> <span class="o">=</span> <span class="mi">101</span>
+ <span class="n">LIGHTGREEN_EX</span> <span class="o">=</span> <span class="mi">102</span>
+ <span class="n">LIGHTYELLOW_EX</span> <span class="o">=</span> <span class="mi">103</span>
+ <span class="n">LIGHTBLUE_EX</span> <span class="o">=</span> <span class="mi">104</span>
+ <span class="n">LIGHTMAGENTA_EX</span> <span class="o">=</span> <span class="mi">105</span>
+ <span class="n">LIGHTCYAN_EX</span> <span class="o">=</span> <span class="mi">106</span>
+ <span class="n">LIGHTWHITE_EX</span> <span class="o">=</span> <span class="mi">107</span>
+
+</div>
+<div class="viewcode-block" id="AnsiStyle"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle">[docs]</a><span class="k">class</span> <span class="nc">AnsiStyle</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
+ <span class="n">BRIGHT</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="n">DIM</span> <span class="o">=</span> <span class="mi">2</span>
+ <span class="n">NORMAL</span> <span class="o">=</span> <span class="mi">22</span>
+ <span class="n">RESET_ALL</span> <span class="o">=</span> <span class="mi">0</span>
+</div>
+<span class="n">Fore</span> <span class="o">=</span> <span class="n">AnsiFore</span><span class="p">()</span>
+<span class="n">Back</span> <span class="o">=</span> <span class="n">AnsiBack</span><span class="p">()</span>
+<span class="n">Style</span> <span class="o">=</span> <span class="n">AnsiStyle</span><span class="p">()</span>
+<span class="n">Cursor</span> <span class="o">=</span> <span class="n">AnsiCursor</span><span class="p">()</span>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../../index.html">
+ <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../../index.html">Documentation overview</a><ul>
+ <li><a href="../../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.colorama.ansitowin32 — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.colorama.ansitowin32</h1><div class="highlight"><pre>
+<span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">os</span>
+
+<span class="kn">from</span> <span class="nn">.ansi</span> <span class="kn">import</span> <span class="n">AnsiFore</span><span class="p">,</span> <span class="n">AnsiBack</span><span class="p">,</span> <span class="n">AnsiStyle</span><span class="p">,</span> <span class="n">Style</span>
+<span class="kn">from</span> <span class="nn">.winterm</span> <span class="kn">import</span> <span class="n">WinTerm</span><span class="p">,</span> <span class="n">WinColor</span><span class="p">,</span> <span class="n">WinStyle</span>
+<span class="kn">from</span> <span class="nn">.win32</span> <span class="kn">import</span> <span class="n">windll</span><span class="p">,</span> <span class="n">winapi_test</span>
+
+
+<span class="n">winterm</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="k">if</span> <span class="n">windll</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">winterm</span> <span class="o">=</span> <span class="n">WinTerm</span><span class="p">()</span>
+
+
+<div class="viewcode-block" id="is_stream_closed"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_stream_closed">[docs]</a><span class="k">def</span> <span class="nf">is_stream_closed</span><span class="p">(</span><span class="n">stream</span><span class="p">):</span>
+ <span class="k">return</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="s">'closed'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">stream</span><span class="o">.</span><span class="n">closed</span>
+
+</div>
+<div class="viewcode-block" id="is_a_tty"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_a_tty">[docs]</a><span class="k">def</span> <span class="nf">is_a_tty</span><span class="p">(</span><span class="n">stream</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="s">'isatty'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">stream</span><span class="o">.</span><span class="n">isatty</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="StreamWrapper"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper">[docs]</a><span class="k">class</span> <span class="nc">StreamWrapper</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">'''</span>
+<span class="sd"> Wraps a stream (such as stdout), acting as a transparent proxy for all</span>
+<span class="sd"> attribute access apart from method 'write()', which is delegated to our</span>
+<span class="sd"> Converter instance.</span>
+<span class="sd"> '''</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wrapped</span><span class="p">,</span> <span class="n">converter</span><span class="p">):</span>
+ <span class="c"># double-underscore everything to prevent clashes with names of</span>
+ <span class="c"># attributes on the wrapped stream object.</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__wrapped</span> <span class="o">=</span> <span class="n">wrapped</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__convertor</span> <span class="o">=</span> <span class="n">converter</span>
+
+ <span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__wrapped</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+
+<div class="viewcode-block" id="StreamWrapper.write"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__convertor</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+</div></div>
+<div class="viewcode-block" id="AnsiToWin32"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32">[docs]</a><span class="k">class</span> <span class="nc">AnsiToWin32</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">'''</span>
+<span class="sd"> Implements a 'write()' method which, on Windows, will strip ANSI character</span>
+<span class="sd"> sequences from the text, and if outputting to a tty, will convert them into</span>
+<span class="sd"> win32 function calls.</span>
+<span class="sd"> '''</span>
+ <span class="n">ANSI_CSI_RE</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">'</span><span class="se">\001</span><span class="s">?</span><span class="se">\033</span><span class="s">\[((?:\d|;)*)([a-zA-Z])</span><span class="se">\002</span><span class="s">?'</span><span class="p">)</span> <span class="c"># Control Sequence Introducer</span>
+ <span class="n">ANSI_OSC_RE</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">'</span><span class="se">\001</span><span class="s">?</span><span class="se">\033</span><span class="s">\]((?:.|;)*?)(</span><span class="se">\x07</span><span class="s">)</span><span class="se">\002</span><span class="s">?'</span><span class="p">)</span> <span class="c"># Operating System Command</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wrapped</span><span class="p">,</span> <span class="n">convert</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">strip</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">autoreset</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="c"># The wrapped stream (normally sys.stdout or sys.stderr)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span> <span class="o">=</span> <span class="n">wrapped</span>
+
+ <span class="c"># should we reset colors to defaults after every .write()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span> <span class="o">=</span> <span class="n">autoreset</span>
+
+ <span class="c"># create the proxy wrapping our output stream</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">StreamWrapper</span><span class="p">(</span><span class="n">wrapped</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
+
+ <span class="n">on_windows</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s">'nt'</span>
+ <span class="c"># We test if the WinAPI works, because even if we are on Windows</span>
+ <span class="c"># we may be using a terminal that doesn't support the WinAPI</span>
+ <span class="c"># (e.g. Cygwin Terminal). In this case it's up to the terminal</span>
+ <span class="c"># to support the ANSI codes.</span>
+ <span class="n">conversion_supported</span> <span class="o">=</span> <span class="n">on_windows</span> <span class="ow">and</span> <span class="n">winapi_test</span><span class="p">()</span>
+
+ <span class="c"># should we strip ANSI sequences from our output?</span>
+ <span class="k">if</span> <span class="n">strip</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">strip</span> <span class="o">=</span> <span class="n">conversion_supported</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="n">is_stream_closed</span><span class="p">(</span><span class="n">wrapped</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">is_a_tty</span><span class="p">(</span><span class="n">wrapped</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">strip</span> <span class="o">=</span> <span class="n">strip</span>
+
+ <span class="c"># should we should convert ANSI sequences into win32 calls?</span>
+ <span class="k">if</span> <span class="n">convert</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">convert</span> <span class="o">=</span> <span class="n">conversion_supported</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">is_stream_closed</span><span class="p">(</span><span class="n">wrapped</span><span class="p">)</span> <span class="ow">and</span> <span class="n">is_a_tty</span><span class="p">(</span><span class="n">wrapped</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">convert</span> <span class="o">=</span> <span class="n">convert</span>
+
+ <span class="c"># dict of ansi codes to win32 functions and parameters</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">win32_calls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_win32_calls</span><span class="p">()</span>
+
+ <span class="c"># are we wrapping stderr?</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span> <span class="ow">is</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span>
+
+<div class="viewcode-block" id="AnsiToWin32.should_wrap"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.should_wrap">[docs]</a> <span class="k">def</span> <span class="nf">should_wrap</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''</span>
+<span class="sd"> True if this class is actually needed. If false, then the output</span>
+<span class="sd"> stream will not be affected, nor will win32 calls be issued, so</span>
+<span class="sd"> wrapping stdout is not actually required. This will generally be</span>
+<span class="sd"> False on non-Windows platforms, unless optional functionality like</span>
+<span class="sd"> autoreset has been requested using kwargs to init()</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">strip</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span>
+</div>
+<div class="viewcode-block" id="AnsiToWin32.get_win32_calls"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.get_win32_calls">[docs]</a> <span class="k">def</span> <span class="nf">get_win32_calls</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert</span> <span class="ow">and</span> <span class="n">winterm</span><span class="p">:</span>
+ <span class="k">return</span> <span class="p">{</span>
+ <span class="n">AnsiStyle</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">reset_all</span><span class="p">,</span> <span class="p">),</span>
+ <span class="n">AnsiStyle</span><span class="o">.</span><span class="n">BRIGHT</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">style</span><span class="p">,</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT</span><span class="p">),</span>
+ <span class="n">AnsiStyle</span><span class="o">.</span><span class="n">DIM</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">style</span><span class="p">,</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">),</span>
+ <span class="n">AnsiStyle</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">style</span><span class="p">,</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">BLACK</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLACK</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">RED</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">RED</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">GREEN</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREEN</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">BLUE</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLUE</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">CYAN</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">CYAN</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">WHITE</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREY</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">RESET</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTBLACK_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLACK</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTRED_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">RED</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTGREEN_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREEN</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTYELLOW_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTBLUE_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLUE</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTMAGENTA_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTCYAN_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">CYAN</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiFore</span><span class="o">.</span><span class="n">LIGHTWHITE_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">fore</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREY</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">BLACK</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLACK</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">RED</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">RED</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">GREEN</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREEN</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">BLUE</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLUE</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">CYAN</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">CYAN</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">WHITE</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREY</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">RESET</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTBLACK_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLACK</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTRED_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">RED</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTGREEN_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREEN</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTYELLOW_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTBLUE_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">BLUE</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTMAGENTA_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTCYAN_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">CYAN</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="n">AnsiBack</span><span class="o">.</span><span class="n">LIGHTWHITE_EX</span><span class="p">:</span> <span class="p">(</span><span class="n">winterm</span><span class="o">.</span><span class="n">back</span><span class="p">,</span> <span class="n">WinColor</span><span class="o">.</span><span class="n">GREY</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
+ <span class="p">}</span>
+ <span class="k">return</span> <span class="nb">dict</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="AnsiToWin32.write"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">strip</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write_and_convert</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">reset_all</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.reset_all"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.reset_all">[docs]</a> <span class="k">def</span> <span class="nf">reset_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">call_win32</span><span class="p">(</span><span class="s">'m'</span><span class="p">,</span> <span class="p">(</span><span class="mi">0</span><span class="p">,))</span>
+ <span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">strip</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">is_stream_closed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">Style</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.write_and_convert"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_and_convert">[docs]</a> <span class="k">def</span> <span class="nf">write_and_convert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="sd">'''</span>
+<span class="sd"> Write the given text to our wrapped stream, stripping any ANSI</span>
+<span class="sd"> sequences from the text, and optionally converting them into win32</span>
+<span class="sd"> calls.</span>
+<span class="sd"> '''</span>
+ <span class="n">cursor</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert_osc</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ANSI_CSI_RE</span><span class="o">.</span><span class="n">finditer</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
+ <span class="n">start</span><span class="p">,</span> <span class="n">end</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">span</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write_plain_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">cursor</span><span class="p">,</span> <span class="n">start</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">convert_ansi</span><span class="p">(</span><span class="o">*</span><span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">())</span>
+ <span class="n">cursor</span> <span class="o">=</span> <span class="n">end</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write_plain_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">cursor</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.write_plain_text"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_plain_text">[docs]</a> <span class="k">def</span> <span class="nf">write_plain_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">start</span> <span class="o"><</span> <span class="n">end</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">])</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wrapped</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.convert_ansi"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_ansi">[docs]</a> <span class="k">def</span> <span class="nf">convert_ansi</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">paramstring</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert</span><span class="p">:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extract_params</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">paramstring</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">call_win32</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.extract_params"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.extract_params">[docs]</a> <span class="k">def</span> <span class="nf">extract_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">paramstring</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'Hf'</span><span class="p">:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span> <span class="k">else</span> <span class="mi">1</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">paramstring</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">';'</span><span class="p">))</span>
+ <span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">params</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
+ <span class="c"># defaults:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="n">params</span> <span class="o">+</span> <span class="p">(</span><span class="mi">1</span><span class="p">,)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">paramstring</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">';'</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">params</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c"># defaults:</span>
+ <span class="k">if</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'JKm'</span><span class="p">:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,)</span>
+ <span class="k">elif</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'ABCD'</span><span class="p">:</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,)</span>
+
+ <span class="k">return</span> <span class="n">params</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.call_win32"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.call_win32">[docs]</a> <span class="k">def</span> <span class="nf">call_win32</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">command</span> <span class="o">==</span> <span class="s">'m'</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">param</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">win32_calls</span><span class="p">:</span>
+ <span class="n">func_args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">win32_calls</span><span class="p">[</span><span class="n">param</span><span class="p">]</span>
+ <span class="n">func</span> <span class="o">=</span> <span class="n">func_args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="n">func_args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
+ <span class="n">kwargs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">on_stderr</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span><span class="p">)</span>
+ <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'J'</span><span class="p">:</span>
+ <span class="n">winterm</span><span class="o">.</span><span class="n">erase_screen</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'K'</span><span class="p">:</span>
+ <span class="n">winterm</span><span class="o">.</span><span class="n">erase_line</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'Hf'</span><span class="p">:</span> <span class="c"># cursor position - absolute</span>
+ <span class="n">winterm</span><span class="o">.</span><span class="n">set_cursor_position</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'ABCD'</span><span class="p">:</span> <span class="c"># cursor position - relative</span>
+ <span class="n">n</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="c"># A - up, B - down, C - forward, D - back</span>
+ <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="p">{</span><span class="s">'A'</span><span class="p">:</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="n">n</span><span class="p">),</span> <span class="s">'B'</span><span class="p">:</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">n</span><span class="p">),</span> <span class="s">'C'</span><span class="p">:</span> <span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="s">'D'</span><span class="p">:</span> <span class="p">(</span><span class="o">-</span><span class="n">n</span><span class="p">,</span> <span class="mi">0</span><span class="p">)}[</span><span class="n">command</span><span class="p">]</span>
+ <span class="n">winterm</span><span class="o">.</span><span class="n">cursor_adjust</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">on_stderr</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="AnsiToWin32.convert_osc"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_osc">[docs]</a> <span class="k">def</span> <span class="nf">convert_osc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ANSI_OSC_RE</span><span class="o">.</span><span class="n">finditer</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
+ <span class="n">start</span><span class="p">,</span> <span class="n">end</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">span</span><span class="p">()</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">text</span><span class="p">[:</span><span class="n">start</span><span class="p">]</span> <span class="o">+</span> <span class="n">text</span><span class="p">[</span><span class="n">end</span><span class="p">:]</span>
+ <span class="n">paramstring</span><span class="p">,</span> <span class="n">command</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">command</span> <span class="ow">in</span> <span class="s">'</span><span class="se">\x07</span><span class="s">'</span><span class="p">:</span> <span class="c"># \x07 = BEL</span>
+ <span class="n">params</span> <span class="o">=</span> <span class="n">paramstring</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">";"</span><span class="p">)</span>
+ <span class="c"># 0 - change title and icon (we will only change title)</span>
+ <span class="c"># 1 - change icon (we don't support this)</span>
+ <span class="c"># 2 - change title</span>
+ <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="s">'02'</span><span class="p">:</span>
+ <span class="n">winterm</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">text</span></div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../../index.html">
+ <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../../index.html">Documentation overview</a><ul>
+ <li><a href="../../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.colorama.initialise — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.colorama.initialise</h1><div class="highlight"><pre>
+<span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
+<span class="kn">import</span> <span class="nn">atexit</span>
+<span class="kn">import</span> <span class="nn">contextlib</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+
+<span class="kn">from</span> <span class="nn">.ansitowin32</span> <span class="kn">import</span> <span class="n">AnsiToWin32</span>
+
+
+<span class="n">orig_stdout</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="n">orig_stderr</span> <span class="o">=</span> <span class="bp">None</span>
+
+<span class="n">wrapped_stdout</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="n">wrapped_stderr</span> <span class="o">=</span> <span class="bp">None</span>
+
+<span class="n">atexit_done</span> <span class="o">=</span> <span class="bp">False</span>
+
+
+<div class="viewcode-block" id="reset_all"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.reset_all">[docs]</a><span class="k">def</span> <span class="nf">reset_all</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">AnsiToWin32</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> <span class="c"># Issue #74: objects might become None at exit</span>
+ <span class="n">AnsiToWin32</span><span class="p">(</span><span class="n">orig_stdout</span><span class="p">)</span><span class="o">.</span><span class="n">reset_all</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="init"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.init">[docs]</a><span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="n">autoreset</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">convert</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">strip</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">wrap</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">wrap</span> <span class="ow">and</span> <span class="nb">any</span><span class="p">([</span><span class="n">autoreset</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">]):</span>
+ <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'wrap=False conflicts with any other arg=True'</span><span class="p">)</span>
+
+ <span class="k">global</span> <span class="n">wrapped_stdout</span><span class="p">,</span> <span class="n">wrapped_stderr</span>
+ <span class="k">global</span> <span class="n">orig_stdout</span><span class="p">,</span> <span class="n">orig_stderr</span>
+
+ <span class="n">orig_stdout</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span>
+ <span class="n">orig_stderr</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span>
+
+ <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">wrapped_stdout</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">wrapped_stdout</span> <span class="o">=</span> \
+ <span class="n">wrap_stream</span><span class="p">(</span><span class="n">orig_stdout</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">wrapped_stderr</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">wrapped_stderr</span> <span class="o">=</span> \
+ <span class="n">wrap_stream</span><span class="p">(</span><span class="n">orig_stderr</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">)</span>
+
+ <span class="k">global</span> <span class="n">atexit_done</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">atexit_done</span><span class="p">:</span>
+ <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">reset_all</span><span class="p">)</span>
+ <span class="n">atexit_done</span> <span class="o">=</span> <span class="bp">True</span>
+
+</div>
+<div class="viewcode-block" id="deinit"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.deinit">[docs]</a><span class="k">def</span> <span class="nf">deinit</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">orig_stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">orig_stdout</span>
+ <span class="k">if</span> <span class="n">orig_stderr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">orig_stderr</span>
+
+</div>
+<span class="nd">@contextlib.contextmanager</span>
+<div class="viewcode-block" id="colorama_text"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">[docs]</a><span class="k">def</span> <span class="nf">colorama_text</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="n">init</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">yield</span>
+ <span class="k">finally</span><span class="p">:</span>
+ <span class="n">deinit</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="reinit"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.reinit">[docs]</a><span class="k">def</span> <span class="nf">reinit</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">wrapped_stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">wrapped_stdout</span>
+ <span class="k">if</span> <span class="n">wrapped_stderr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">wrapped_stderr</span>
+
+</div>
+<div class="viewcode-block" id="wrap_stream"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.wrap_stream">[docs]</a><span class="k">def</span> <span class="nf">wrap_stream</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">wrap</span><span class="p">:</span>
+ <span class="n">wrapper</span> <span class="o">=</span> <span class="n">AnsiToWin32</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span>
+ <span class="n">convert</span><span class="o">=</span><span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="o">=</span><span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="o">=</span><span class="n">autoreset</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">wrapper</span><span class="o">.</span><span class="n">should_wrap</span><span class="p">():</span>
+ <span class="n">stream</span> <span class="o">=</span> <span class="n">wrapper</span><span class="o">.</span><span class="n">stream</span>
+ <span class="k">return</span> <span class="n">stream</span>
+</pre></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../../index.html">
+ <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../../index.html">Documentation overview</a><ul>
+ <li><a href="../../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.colorama.win32 — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.colorama.win32</h1><div class="highlight"><pre>
+<span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
+
+<span class="c"># from winbase.h</span>
+<span class="n">STDOUT</span> <span class="o">=</span> <span class="o">-</span><span class="mi">11</span>
+<span class="n">STDERR</span> <span class="o">=</span> <span class="o">-</span><span class="mi">12</span>
+
+<span class="k">try</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">ctypes</span>
+ <span class="kn">from</span> <span class="nn">ctypes</span> <span class="kn">import</span> <span class="n">LibraryLoader</span>
+ <span class="n">windll</span> <span class="o">=</span> <span class="n">LibraryLoader</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">WinDLL</span><span class="p">)</span>
+ <span class="kn">from</span> <span class="nn">ctypes</span> <span class="kn">import</span> <span class="n">wintypes</span>
+<span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">):</span>
+ <span class="n">windll</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="n">SetConsoleTextAttribute</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">_</span><span class="p">:</span> <span class="bp">None</span>
+ <span class="n">winapi_test</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">_</span><span class="p">:</span> <span class="bp">None</span>
+<span class="k">else</span><span class="p">:</span>
+ <span class="kn">from</span> <span class="nn">ctypes</span> <span class="kn">import</span> <span class="n">byref</span><span class="p">,</span> <span class="n">Structure</span><span class="p">,</span> <span class="n">c_char</span><span class="p">,</span> <span class="n">POINTER</span>
+
+ <span class="n">COORD</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">_COORD</span>
+
+ <span class="k">class</span> <span class="nc">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">(</span><span class="n">Structure</span><span class="p">):</span>
+ <span class="sd">"""struct in wincon.h."""</span>
+ <span class="n">_fields_</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="p">(</span><span class="s">"dwSize"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"dwCursorPosition"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"wAttributes"</span><span class="p">,</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"srWindow"</span><span class="p">,</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">SMALL_RECT</span><span class="p">),</span>
+ <span class="p">(</span><span class="s">"dwMaximumWindowSize"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
+ <span class="p">]</span>
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">'(</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">)'</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span>
+ <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">X</span>
+ <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">wAttributes</span>
+ <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Top</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Left</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Bottom</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Right</span>
+ <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwMaximumWindowSize</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwMaximumWindowSize</span><span class="o">.</span><span class="n">X</span>
+ <span class="p">)</span>
+
+ <span class="n">_GetStdHandle</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetStdHandle</span>
+ <span class="n">_GetStdHandle</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="n">_GetStdHandle</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span>
+
+ <span class="n">_GetConsoleScreenBufferInfo</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span>
+ <span class="n">_GetConsoleScreenBufferInfo</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
+ <span class="n">POINTER</span><span class="p">(</span><span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">),</span>
+ <span class="p">]</span>
+ <span class="n">_GetConsoleScreenBufferInfo</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">_SetConsoleTextAttribute</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleTextAttribute</span>
+ <span class="n">_SetConsoleTextAttribute</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="n">_SetConsoleTextAttribute</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">_SetConsoleCursorPosition</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleCursorPosition</span>
+ <span class="n">_SetConsoleCursorPosition</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
+ <span class="n">COORD</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="n">_SetConsoleCursorPosition</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">_FillConsoleOutputCharacterA</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">FillConsoleOutputCharacterA</span>
+ <span class="n">_FillConsoleOutputCharacterA</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
+ <span class="n">c_char</span><span class="p">,</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
+ <span class="n">COORD</span><span class="p">,</span>
+ <span class="n">POINTER</span><span class="p">(</span><span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">),</span>
+ <span class="p">]</span>
+ <span class="n">_FillConsoleOutputCharacterA</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">_FillConsoleOutputAttribute</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">FillConsoleOutputAttribute</span>
+ <span class="n">_FillConsoleOutputAttribute</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">,</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
+ <span class="n">COORD</span><span class="p">,</span>
+ <span class="n">POINTER</span><span class="p">(</span><span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">),</span>
+ <span class="p">]</span>
+ <span class="n">_FillConsoleOutputAttribute</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">_SetConsoleTitleW</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleTitleA</span>
+ <span class="n">_SetConsoleTitleW</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="n">wintypes</span><span class="o">.</span><span class="n">LPCSTR</span>
+ <span class="p">]</span>
+ <span class="n">_SetConsoleTitleW</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
+
+ <span class="n">handles</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="n">STDOUT</span><span class="p">:</span> <span class="n">_GetStdHandle</span><span class="p">(</span><span class="n">STDOUT</span><span class="p">),</span>
+ <span class="n">STDERR</span><span class="p">:</span> <span class="n">_GetStdHandle</span><span class="p">(</span><span class="n">STDERR</span><span class="p">),</span>
+ <span class="p">}</span>
+
+<div class="viewcode-block" id="winapi_test"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.win32.winapi_test">[docs]</a> <span class="k">def</span> <span class="nf">winapi_test</span><span class="p">():</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">STDOUT</span><span class="p">]</span>
+ <span class="n">csbi</span> <span class="o">=</span> <span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">()</span>
+ <span class="n">success</span> <span class="o">=</span> <span class="n">_GetConsoleScreenBufferInfo</span><span class="p">(</span>
+ <span class="n">handle</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">csbi</span><span class="p">))</span>
+ <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">success</span><span class="p">)</span>
+</div>
+ <span class="k">def</span> <span class="nf">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">stream_id</span><span class="o">=</span><span class="n">STDOUT</span><span class="p">):</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
+ <span class="n">csbi</span> <span class="o">=</span> <span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">()</span>
+ <span class="n">success</span> <span class="o">=</span> <span class="n">_GetConsoleScreenBufferInfo</span><span class="p">(</span>
+ <span class="n">handle</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">csbi</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">csbi</span>
+
+<div class="viewcode-block" id="SetConsoleTextAttribute"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.win32.SetConsoleTextAttribute">[docs]</a> <span class="k">def</span> <span class="nf">SetConsoleTextAttribute</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">_SetConsoleTextAttribute</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">attrs</span><span class="p">)</span>
+</div>
+ <span class="k">def</span> <span class="nf">SetConsoleCursorPosition</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">position</span><span class="p">,</span> <span class="n">adjust</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="n">position</span> <span class="o">=</span> <span class="n">COORD</span><span class="p">(</span><span class="o">*</span><span class="n">position</span><span class="p">)</span>
+ <span class="c"># If the position is out of range, do nothing.</span>
+ <span class="k">if</span> <span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o"><=</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="c"># Adjust for Windows' SetConsoleCursorPosition:</span>
+ <span class="c"># 1. being 0-based, while ANSI is 1-based.</span>
+ <span class="c"># 2. expecting (x,y), while ANSI uses (y,x).</span>
+ <span class="n">adjusted_position</span> <span class="o">=</span> <span class="n">COORD</span><span class="p">(</span><span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o">-</span> <span class="mi">1</span><span class="p">,</span> <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">adjust</span><span class="p">:</span>
+ <span class="c"># Adjust for viewport's scroll position</span>
+ <span class="n">sr</span> <span class="o">=</span> <span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">STDOUT</span><span class="p">)</span><span class="o">.</span><span class="n">srWindow</span>
+ <span class="n">adjusted_position</span><span class="o">.</span><span class="n">Y</span> <span class="o">+=</span> <span class="n">sr</span><span class="o">.</span><span class="n">Top</span>
+ <span class="n">adjusted_position</span><span class="o">.</span><span class="n">X</span> <span class="o">+=</span> <span class="n">sr</span><span class="o">.</span><span class="n">Left</span>
+ <span class="c"># Resume normal processing</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">_SetConsoleCursorPosition</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">adjusted_position</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">FillConsoleOutputCharacter</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">char</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
+ <span class="n">char</span> <span class="o">=</span> <span class="n">c_char</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
+ <span class="n">length</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="n">length</span><span class="p">)</span>
+ <span class="n">num_written</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+ <span class="c"># Note that this is hard-coded for ANSI (vs wide) bytes.</span>
+ <span class="n">success</span> <span class="o">=</span> <span class="n">_FillConsoleOutputCharacterA</span><span class="p">(</span>
+ <span class="n">handle</span><span class="p">,</span> <span class="n">char</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">num_written</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">num_written</span><span class="o">.</span><span class="n">value</span>
+
+ <span class="k">def</span> <span class="nf">FillConsoleOutputAttribute</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span>
+ <span class="sd">''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )'''</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
+ <span class="n">attribute</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
+ <span class="n">length</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="n">length</span><span class="p">)</span>
+ <span class="n">num_written</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+ <span class="c"># Note that this is hard-coded for ANSI (vs wide) bytes.</span>
+ <span class="k">return</span> <span class="n">_FillConsoleOutputAttribute</span><span class="p">(</span>
+ <span class="n">handle</span><span class="p">,</span> <span class="n">attribute</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">num_written</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">SetConsoleTitle</span><span class="p">(</span><span class="n">title</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">_SetConsoleTitleW</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../../index.html">
+ <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../../index.html">Documentation overview</a><ul>
+ <li><a href="../../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.colorama.winterm — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.colorama.winterm</h1><div class="highlight"><pre>
+<span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">win32</span>
+
+
+<span class="c"># from wincon.h</span>
+<div class="viewcode-block" id="WinColor"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor">[docs]</a><span class="k">class</span> <span class="nc">WinColor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="n">BLACK</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">2</span>
+ <span class="n">CYAN</span> <span class="o">=</span> <span class="mi">3</span>
+ <span class="n">RED</span> <span class="o">=</span> <span class="mi">4</span>
+ <span class="n">MAGENTA</span> <span class="o">=</span> <span class="mi">5</span>
+ <span class="n">YELLOW</span> <span class="o">=</span> <span class="mi">6</span>
+ <span class="n">GREY</span> <span class="o">=</span> <span class="mi">7</span>
+
+<span class="c"># from wincon.h</span></div>
+<div class="viewcode-block" id="WinStyle"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle">[docs]</a><span class="k">class</span> <span class="nc">WinStyle</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="n">NORMAL</span> <span class="o">=</span> <span class="mh">0x00</span> <span class="c"># dim text, dim background</span>
+ <span class="n">BRIGHT</span> <span class="o">=</span> <span class="mh">0x08</span> <span class="c"># bright text, dim background</span>
+ <span class="n">BRIGHT_BACKGROUND</span> <span class="o">=</span> <span class="mh">0x80</span> <span class="c"># dim text, bright background</span>
+</div>
+<div class="viewcode-block" id="WinTerm"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm">[docs]</a><span class="k">class</span> <span class="nc">WinTerm</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_default</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span><span class="o">.</span><span class="n">wAttributes</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_attrs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_default_fore</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fore</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_default_back</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_back</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_default_style</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_style</span>
+ <span class="c"># In order to emulate LIGHT_EX in windows, we borrow the BRIGHT style.</span>
+ <span class="c"># So that LIGHT_EX colors and BRIGHT style do not clobber each other,</span>
+ <span class="c"># we track them separately, since LIGHT_EX is overwritten by Fore/Back</span>
+ <span class="c"># and BRIGHT is overwritten by Style codes.</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_light</span> <span class="o">=</span> <span class="mi">0</span>
+
+<div class="viewcode-block" id="WinTerm.get_attrs"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_attrs">[docs]</a> <span class="k">def</span> <span class="nf">get_attrs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fore</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_back</span> <span class="o">*</span> <span class="mi">16</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_style</span> <span class="o">|</span> <span class="bp">self</span><span class="o">.</span><span class="n">_light</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.set_attrs"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_attrs">[docs]</a> <span class="k">def</span> <span class="nf">set_attrs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_fore</span> <span class="o">=</span> <span class="n">value</span> <span class="o">&</span> <span class="mi">7</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_back</span> <span class="o">=</span> <span class="p">(</span><span class="n">value</span> <span class="o">>></span> <span class="mi">4</span><span class="p">)</span> <span class="o">&</span> <span class="mi">7</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_style</span> <span class="o">=</span> <span class="n">value</span> <span class="o">&</span> <span class="p">(</span><span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT</span> <span class="o">|</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT_BACKGROUND</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.reset_all"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.reset_all">[docs]</a> <span class="k">def</span> <span class="nf">reset_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_attrs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_console</span><span class="p">(</span><span class="n">attrs</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.fore"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.fore">[docs]</a> <span class="k">def</span> <span class="nf">fore</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fore</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">light</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">fore</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">fore</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_fore</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_fore</span> <span class="o">=</span> <span class="n">fore</span>
+ <span class="c"># Emulate LIGHT_EX with BRIGHT Style</span>
+ <span class="k">if</span> <span class="n">light</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_light</span> <span class="o">|=</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_light</span> <span class="o">&=</span> <span class="o">~</span><span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_console</span><span class="p">(</span><span class="n">on_stderr</span><span class="o">=</span><span class="n">on_stderr</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.back"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.back">[docs]</a> <span class="k">def</span> <span class="nf">back</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">back</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">light</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">back</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">back</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_back</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_back</span> <span class="o">=</span> <span class="n">back</span>
+ <span class="c"># Emulate LIGHT_EX with BRIGHT_BACKGROUND Style</span>
+ <span class="k">if</span> <span class="n">light</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_light</span> <span class="o">|=</span> <span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT_BACKGROUND</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_light</span> <span class="o">&=</span> <span class="o">~</span><span class="n">WinStyle</span><span class="o">.</span><span class="n">BRIGHT_BACKGROUND</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_console</span><span class="p">(</span><span class="n">on_stderr</span><span class="o">=</span><span class="n">on_stderr</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.style"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.style">[docs]</a> <span class="k">def</span> <span class="nf">style</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">style</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">style</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_style</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_style</span> <span class="o">=</span> <span class="n">style</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_console</span><span class="p">(</span><span class="n">on_stderr</span><span class="o">=</span><span class="n">on_stderr</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.set_console"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_console">[docs]</a> <span class="k">def</span> <span class="nf">set_console</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attrs</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">attrs</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">attrs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_attrs</span><span class="p">()</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span>
+ <span class="k">if</span> <span class="n">on_stderr</span><span class="p">:</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDERR</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">SetConsoleTextAttribute</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">attrs</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.get_position"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_position">[docs]</a> <span class="k">def</span> <span class="nf">get_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handle</span><span class="p">):</span>
+ <span class="n">position</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span><span class="o">.</span><span class="n">dwCursorPosition</span>
+ <span class="c"># Because Windows coordinates are 0-based,</span>
+ <span class="c"># and win32.SetConsoleCursorPosition expects 1-based.</span>
+ <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">position</span>
+</div>
+<div class="viewcode-block" id="WinTerm.set_cursor_position"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_cursor_position">[docs]</a> <span class="k">def</span> <span class="nf">set_cursor_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">position</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="c"># I'm not currently tracking the position, so there is no default.</span>
+ <span class="c"># position = self.get_position()</span>
+ <span class="k">return</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span>
+ <span class="k">if</span> <span class="n">on_stderr</span><span class="p">:</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDERR</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">SetConsoleCursorPosition</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">position</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.cursor_adjust"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.cursor_adjust">[docs]</a> <span class="k">def</span> <span class="nf">cursor_adjust</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span>
+ <span class="k">if</span> <span class="n">on_stderr</span><span class="p">:</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDERR</span>
+ <span class="n">position</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_position</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span>
+ <span class="n">adjusted_position</span> <span class="o">=</span> <span class="p">(</span><span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o">+</span> <span class="n">y</span><span class="p">,</span> <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o">+</span> <span class="n">x</span><span class="p">)</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">SetConsoleCursorPosition</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">adjusted_position</span><span class="p">,</span> <span class="n">adjust</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.erase_screen"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_screen">[docs]</a> <span class="k">def</span> <span class="nf">erase_screen</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="c"># 0 should clear from the cursor to the end of the screen.</span>
+ <span class="c"># 1 should clear from the cursor to the beginning of the screen.</span>
+ <span class="c"># 2 should clear the entire screen, and move cursor to (1,1)</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span>
+ <span class="k">if</span> <span class="n">on_stderr</span><span class="p">:</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDERR</span>
+ <span class="n">csbi</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span>
+ <span class="c"># get the number of character cells in the current buffer</span>
+ <span class="n">cells_in_screen</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span> <span class="o">*</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">Y</span>
+ <span class="c"># get number of character cells before current cursor position</span>
+ <span class="n">cells_before_cursor</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span> <span class="o">*</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">Y</span> <span class="o">+</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">X</span>
+ <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">cells_in_screen</span> <span class="o">-</span> <span class="n">cells_before_cursor</span>
+ <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">COORD</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">cells_before_cursor</span>
+ <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">COORD</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">cells_in_screen</span>
+ <span class="c"># fill the entire screen with blanks</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">FillConsoleOutputCharacter</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="s">' '</span><span class="p">,</span> <span class="n">cells_to_erase</span><span class="p">,</span> <span class="n">from_coord</span><span class="p">)</span>
+ <span class="c"># now set the buffer's attributes accordingly</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">FillConsoleOutputAttribute</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_attrs</span><span class="p">(),</span> <span class="n">cells_to_erase</span><span class="p">,</span> <span class="n">from_coord</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
+ <span class="c"># put the cursor where needed</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">SetConsoleCursorPosition</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="WinTerm.erase_line"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_line">[docs]</a> <span class="k">def</span> <span class="nf">erase_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">on_stderr</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="c"># 0 should clear from the cursor to the end of the line.</span>
+ <span class="c"># 1 should clear from the cursor to the beginning of the line.</span>
+ <span class="c"># 2 should clear the entire line.</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDOUT</span>
+ <span class="k">if</span> <span class="n">on_stderr</span><span class="p">:</span>
+ <span class="n">handle</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">STDERR</span>
+ <span class="n">csbi</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span> <span class="o">-</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">X</span>
+ <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">COORD</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">Y</span><span class="p">)</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">X</span>
+ <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
+ <span class="n">from_coord</span> <span class="o">=</span> <span class="n">win32</span><span class="o">.</span><span class="n">COORD</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">Y</span><span class="p">)</span>
+ <span class="n">cells_to_erase</span> <span class="o">=</span> <span class="n">csbi</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span>
+ <span class="c"># fill the entire screen with blanks</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">FillConsoleOutputCharacter</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="s">' '</span><span class="p">,</span> <span class="n">cells_to_erase</span><span class="p">,</span> <span class="n">from_coord</span><span class="p">)</span>
+ <span class="c"># now set the buffer's attributes accordingly</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">FillConsoleOutputAttribute</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_attrs</span><span class="p">(),</span> <span class="n">cells_to_erase</span><span class="p">,</span> <span class="n">from_coord</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="WinTerm.set_title"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_title">[docs]</a> <span class="k">def</span> <span class="nf">set_title</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">):</span>
+ <span class="n">win32</span><span class="o">.</span><span class="n">SetConsoleTitle</span><span class="p">(</span><span class="n">title</span><span class="p">)</span></div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../../index.html">
+ <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../../index.html">Documentation overview</a><ul>
+ <li><a href="../../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.compilation — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.compilation</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">shutil</span>
+
+<span class="kn">import</span> <span class="nn">src</span>
+
+<span class="n">C_COMPILE_ENV_LIST</span> <span class="o">=</span> <span class="p">[</span><span class="s">"CC"</span><span class="p">,</span>
+ <span class="s">"CXX"</span><span class="p">,</span>
+ <span class="s">"F77"</span><span class="p">,</span>
+ <span class="s">"CFLAGS"</span><span class="p">,</span>
+ <span class="s">"CXXFLAGS"</span><span class="p">,</span>
+ <span class="s">"LIBS"</span><span class="p">,</span>
+ <span class="s">"LDFLAGS"</span><span class="p">]</span>
+
+<div class="viewcode-block" id="Builder"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder">[docs]</a><span class="k">class</span> <span class="nc">Builder</span><span class="p">:</span>
+ <span class="sd">"""Class to handle all construction steps, like cmake, configure, make, ...</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">config</span><span class="p">,</span>
+ <span class="n">logger</span><span class="p">,</span>
+ <span class="n">product_info</span><span class="p">,</span>
+ <span class="n">options</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">OptResult</span><span class="p">(),</span>
+ <span class="n">check_src</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="n">options</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span> <span class="o">=</span> <span class="n">product_info</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">build_dir</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">source_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="s">"debug"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">debug</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span> <span class="o">=</span> <span class="bp">True</span>
+
+ <span class="c">##</span>
+ <span class="c"># Shortcut method to log in log file.</span>
+<div class="viewcode-block" id="Builder.log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.log">[docs]</a> <span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">showInfo</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">showInfo</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+
+ <span class="c">##</span>
+ <span class="c"># Shortcut method to log a command.</span></div>
+<div class="viewcode-block" id="Builder.log_command"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.log_command">[docs]</a> <span class="k">def</span> <span class="nf">log_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">command</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Prepares the environment.</span>
+ <span class="c"># Build two environment: one for building and one for testing (launch).</span></div>
+<div class="viewcode-block" id="Builder.prepare"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.prepare">[docs]</a> <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+ <span class="c"># create build dir</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">' build_dir = </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">' install_dir = </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span><span class="p">),</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+
+ <span class="c"># add products in depend and opt_depend list recursively</span>
+ <span class="n">environ_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_dependencies</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">)</span>
+ <span class="c">#environ_info.append(self.product_info.name)</span>
+
+ <span class="c"># create build environment</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">Environ</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)),</span>
+ <span class="bp">True</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="o"><</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span> <span class="n">environ_info</span><span class="p">)</span>
+
+ <span class="c"># create runtime environment</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">launch_environ</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">Environ</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)),</span>
+ <span class="bp">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">launch_environ</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">True</span> <span class="c"># no need to show here</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">launch_environ</span><span class="o">.</span><span class="n">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span> <span class="n">environ_info</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">ee</span> <span class="ow">in</span> <span class="n">C_COMPILE_ENV_LIST</span><span class="p">:</span>
+ <span class="n">vv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">ee</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vv</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ee</span><span class="p">,</span> <span class="n">vv</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="mi">0</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs cmake with the given options.</span></div>
+<div class="viewcode-block" id="Builder.cmake"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.cmake">[docs]</a> <span class="k">def</span> <span class="nf">cmake</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+
+ <span class="n">cmake_option</span> <span class="o">=</span> <span class="n">options</span>
+ <span class="c"># cmake_option +=' -DCMAKE_VERBOSE_MAKEFILE=ON -DSALOME_CMAKE_DEBUG=ON'</span>
+ <span class="k">if</span> <span class="s">'cmake_options'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">:</span>
+ <span class="n">cmake_option</span> <span class="o">+=</span> <span class="s">" </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">cmake_options</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
+
+ <span class="c"># add debug option</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span><span class="p">:</span>
+ <span class="n">cmake_option</span> <span class="o">+=</span> <span class="s">" -DCMAKE_BUILD_TYPE=Debug"</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="n">cmake_option</span> <span class="o">+=</span> <span class="s">" -DCMAKE_BUILD_TYPE=Release"</span>
+
+ <span class="c"># In case CMAKE_GENERATOR is defined in environment, </span>
+ <span class="c"># use it in spite of automatically detect it</span>
+ <span class="k">if</span> <span class="s">'cmake_generator'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
+ <span class="n">cmake_option</span> <span class="o">+=</span> <span class="s">" -DCMAKE_GENERATOR=</span><span class="si">%s</span><span class="s">"</span> \
+ <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">cmake_generator</span>
+
+ <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"cmake </span><span class="si">%s</span><span class="s"> -DCMAKE_INSTALL_PREFIX=</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
+ <span class="p">(</span><span class="n">cmake_option</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">source_dir</span><span class="p">))</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+ <span class="c"># for key in sorted(self.build_environ.environ.environ.keys()):</span>
+ <span class="c"># print key, " ", self.build_environ.environ.environ[key]</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"cmake"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs build_configure with the given options.</span></div>
+<div class="viewcode-block" id="Builder.build_configure"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.build_configure">[docs]</a> <span class="k">def</span> <span class="nf">build_configure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+
+ <span class="k">if</span> <span class="s">'buildconfigure_options'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">:</span>
+ <span class="n">options</span> <span class="o">+=</span> <span class="s">" </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">buildconfigure_options</span>
+
+ <span class="n">command</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">/build_configure'</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source_dir</span><span class="p">)</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">options</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"build_configure"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs configure with the given options.</span></div>
+<div class="viewcode-block" id="Builder.configure"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.configure">[docs]</a> <span class="k">def</span> <span class="nf">configure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+
+ <span class="k">if</span> <span class="s">'configure_options'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">:</span>
+ <span class="n">options</span> <span class="o">+=</span> <span class="s">" </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">configure_options</span>
+
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">/configure --prefix=</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source_dir</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span><span class="p">))</span>
+
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">options</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"configure"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+</div>
+<div class="viewcode-block" id="Builder.hack_libtool"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.hack_libtool">[docs]</a> <span class="k">def</span> <span class="nf">hack_libtool</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span> <span class="o">+</span> <span class="s">'libtool'</span><span class="p">)):</span>
+ <span class="k">return</span>
+
+ <span class="n">lf</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span> <span class="s">"libtool"</span><span class="p">),</span> <span class="s">'r'</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">lf</span><span class="o">.</span><span class="n">readlines</span><span class="p">():</span>
+ <span class="k">if</span> <span class="s">'hack_libtool'</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
+ <span class="k">return</span>
+
+ <span class="c"># fix libtool by replacing CC="<compil>" with hack_libtool function</span>
+ <span class="n">hack_command</span><span class="o">=</span><span class="s">'''sed -i "s%^CC=</span><span class="se">\\</span><span class="s">"\(.*\)</span><span class="se">\\</span><span class="s">"%hack_libtool() { </span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s">if test </span><span class="se">\\</span><span class="s">"\$(echo \$@ | grep -E '</span><span class="se">\\\\\\</span><span class="s">-L/usr/lib(/../lib)?(64)? ')</span><span class="se">\\</span><span class="s">" == </span><span class="se">\\\"\\\"</span><span class="s"> </span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> then</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> cmd=</span><span class="se">\\</span><span class="s">"</span><span class="se">\\</span><span class="s">1 \$@</span><span class="se">\\</span><span class="s">"</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> else</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> cmd=</span><span class="se">\\</span><span class="s">"</span><span class="se">\\</span><span class="s">1 </span><span class="se">\\</span><span class="s">"\`echo \$@ | sed -r -e 's|(.*)-L/usr/lib(/../lib)?(64)? (.*)|</span><span class="se">\\\\\\</span><span class="s">1</span><span class="se">\\\\\\</span><span class="s">4 -L/usr/lib</span><span class="se">\\\\\\</span><span class="s">3|g'\`</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> fi</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s"> \$cmd</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s">}</span><span class="se">\\</span><span class="s">n</span><span class="se">\\</span><span class="s"></span>
+<span class="s">CC=</span><span class="se">\\</span><span class="s">"hack_libtool</span><span class="se">\\</span><span class="s">"</span><span class="si">%g</span><span class="s">" libtool'''</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">hack_command</span><span class="p">)</span>
+ <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">hack_command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+
+ <span class="c">##</span>
+ <span class="c"># Runs make to build the module.</span></div>
+<div class="viewcode-block" id="Builder.make"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.make">[docs]</a> <span class="k">def</span> <span class="nf">make</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">,</span> <span class="n">make_opt</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+
+ <span class="c"># make</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">'make'</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" -j"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">nb_proc</span><span class="p">)</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">make_opt</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"make"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs msbuild to build the module.</span></div>
+<div class="viewcode-block" id="Builder.wmake"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.wmake">[docs]</a> <span class="k">def</span> <span class="nf">wmake</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">nb_proc</span><span class="p">,</span> <span class="n">opt_nb_proc</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+
+ <span class="n">hh</span> <span class="o">=</span> <span class="s">'MSBUILD /m:</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">nb_proc</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span><span class="p">:</span>
+ <span class="n">hh</span> <span class="o">+=</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s">"DEBUG"</span><span class="p">)</span>
+ <span class="c"># make</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">'msbuild'</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" /maxcpucount:"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">nb_proc</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" /p:Configuration=Debug"</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" /p:Configuration=Release"</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" ALL_BUILD.vcxproj"</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"make"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs 'make install'.</span></div>
+<div class="viewcode-block" id="Builder.install"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.install">[docs]</a> <span class="k">def</span> <span class="nf">install</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist_name</span><span class="o">==</span><span class="s">"Win"</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">'msbuild INSTALL.vcxproj'</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" /p:Configuration=Debug"</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s">" /p:Configuration=Release"</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">'make install'</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"makeinstall"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs 'make_check'.</span></div>
+<div class="viewcode-block" id="Builder.check"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.check">[docs]</a> <span class="k">def</span> <span class="nf">check</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">'msbuild RUN_TESTS.vcxproj'</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span><span class="o">==</span><span class="s">"autotools"</span> <span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">'make check'</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">'make test'</span>
+
+ <span class="k">if</span> <span class="n">command</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">command</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">launch_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="c">##</span>
+ <span class="c"># Performs a default build for this module.</span></div>
+<div class="viewcode-block" id="Builder.do_default_build"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.do_default_build">[docs]</a> <span class="k">def</span> <span class="nf">do_default_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">build_conf_options</span><span class="o">=</span><span class="s">""</span><span class="p">,</span>
+ <span class="n">configure_options</span><span class="o">=</span><span class="s">""</span><span class="p">,</span>
+ <span class="n">show_warning</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="n">use_autotools</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="s">'use_autotools'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">:</span>
+ <span class="n">uc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">use_autotools</span>
+ <span class="k">if</span> <span class="n">uc</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'always'</span><span class="p">,</span> <span class="s">'yes'</span><span class="p">]:</span>
+ <span class="n">use_autotools</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">uc</span> <span class="o">==</span> <span class="s">'option'</span><span class="p">:</span>
+ <span class="n">use_autotools</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">autotools</span>
+
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">use_autotools</span> <span class="o">=</span> <span class="n">use_autotools</span>
+
+ <span class="n">use_ctest</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="s">'use_ctest'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">:</span>
+ <span class="n">uc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">use_ctest</span>
+ <span class="k">if</span> <span class="n">uc</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'always'</span><span class="p">,</span> <span class="s">'yes'</span><span class="p">]:</span>
+ <span class="n">use_ctest</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">uc</span> <span class="o">==</span> <span class="s">'option'</span><span class="p">:</span>
+ <span class="n">use_ctest</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">ctest</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">use_ctest</span> <span class="o">=</span> <span class="n">use_ctest</span>
+
+ <span class="k">if</span> <span class="n">show_warning</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">if</span> <span class="n">use_autotools</span><span class="p">:</span> <span class="n">cmd</span> <span class="o">=</span> <span class="s">"(autotools)"</span>
+ <span class="k">if</span> <span class="n">use_ctest</span><span class="p">:</span> <span class="n">cmd</span> <span class="o">=</span> <span class="s">"(ctest)"</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s">"</span><span class="si">%(module)s</span><span class="s">: Run default compilation method </span><span class="si">%(cmd)s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">"module"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="p">,</span> <span class="s">"cmd"</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">},</span> <span class="mi">4</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">use_autotools</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepare</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_configure</span><span class="p">(</span>
+ <span class="n">build_conf_options</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">configure</span><span class="p">(</span><span class="n">configure_options</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">make</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">install</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">clean</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+
+ <span class="k">else</span><span class="p">:</span> <span class="c"># CMake</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist_name</span><span class="o">==</span><span class="s">'Win'</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">wprepare</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmake</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">wmake</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">install</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">clean</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepare</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmake</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">make</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">install</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">clean</span><span class="p">():</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span>
+
+ <span class="c">##</span>
+ <span class="c"># Performs a build with a script.</span></div>
+<div class="viewcode-block" id="Builder.do_python_script_build"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.do_python_script_build">[docs]</a> <span class="k">def</span> <span class="nf">do_python_script_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">):</span>
+ <span class="c"># script found</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Compile </span><span class="si">%(product)s</span><span class="s"> using script </span><span class="si">%(script)s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'product'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
+ <span class="s">'script'</span><span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="p">},</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">imp</span>
+ <span class="n">product</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span>
+ <span class="n">pymodule</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_source</span><span class="p">(</span><span class="n">product</span> <span class="o">+</span> <span class="s">"_compile_script"</span><span class="p">,</span> <span class="n">script</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_proc</span> <span class="o">=</span> <span class="n">nb_proc</span>
+ <span class="n">retcode</span> <span class="o">=</span> <span class="n">pymodule</span><span class="o">.</span><span class="n">compil</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">__</span><span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="kn">import</span> <span class="nn">traceback</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_tb</span><span class="p">(</span><span class="n">exceptionTraceback</span><span class="p">)</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
+ <span class="n">retcode</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">finally</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"script"</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">retcode</span>
+</div>
+<div class="viewcode-block" id="Builder.complete_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.complete_environment">[docs]</a> <span class="k">def</span> <span class="nf">complete_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">make_options</span><span class="p">):</span>
+ <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
+ <span class="c"># pass additional variables to environment </span>
+ <span class="c"># (may be used by the build script)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"SOURCE_DIR"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source_dir</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"INSTALL_DIR"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"PRODUCT_INSTALL"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">install_dir</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"BUILD_DIR"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"PRODUCT_BUILD"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"MAKE_OPTIONS"</span><span class="p">,</span> <span class="n">make_options</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"DIST_NAME"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist_name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"DIST_VERSION"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist_version</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"DIST"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"VERSION"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Builder.do_batch_script_build"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.do_batch_script_build">[docs]</a> <span class="k">def</span> <span class="nf">do_batch_script_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">):</span>
+
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="n">make_options</span> <span class="o">=</span> <span class="s">"/maxcpucount:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">nb_proc</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="n">make_options</span> <span class="o">=</span> <span class="s">"-j</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">nb_proc</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log_command</span><span class="p">(</span><span class="s">" "</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s">"Run build script </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">complete_environment</span><span class="p">(</span><span class="n">make_options</span><span class="p">)</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">script</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="p">),</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s">"script"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">res</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="mi">1</span>
+ </div>
+<div class="viewcode-block" id="Builder.do_script_build"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.do_script_build">[docs]</a> <span class="k">def</span> <span class="nf">do_script_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="n">number_of_proc</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="c"># define make options (may not be used by the script)</span>
+ <span class="k">if</span> <span class="n">number_of_proc</span><span class="o">==</span><span class="mi">0</span><span class="p">:</span>
+ <span class="n">nb_proc</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_cfg_param</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="p">,</span><span class="s">"nb_proc"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">nb_proc</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">nb_proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">nb_proc</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">nb_proc</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">number_of_proc</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">nb_proc</span><span class="p">)</span>
+
+ <span class="n">extension</span> <span class="o">=</span> <span class="n">script</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">extension</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"bat"</span><span class="p">,</span><span class="s">"sh"</span><span class="p">]:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">do_batch_script_build</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">extension</span> <span class="o">==</span> <span class="s">"py"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">do_python_script_build</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">)</span>
+
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"The script </span><span class="si">%s</span><span class="s"> must have .sh, .bat or .py extension."</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="Builder.put_txt_log_in_appli_log_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.put_txt_log_in_appli_log_dir">[docs]</a> <span class="k">def</span> <span class="nf">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">):</span>
+ <span class="sd">'''Put the txt log (that contain the system logs, like make command</span>
+<span class="sd"> output) in the directory <APPLICATION DIR>/LOGS/<product_name>/</span>
+<span class="sd"> </span>
+<span class="sd"> :param file_name Str: the name of the file to write</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">==</span> <span class="n">sys</span><span class="o">.</span><span class="n">__stdout__</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="n">dir_where_to_put</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="s">"LOGS"</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dir_where_to_put</span><span class="p">,</span> <span class="n">file_name</span><span class="p">)</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">dir_where_to_put</span><span class="p">)</span>
+ <span class="c"># write the logTxtFile copy it to the destination, and then recreate </span>
+ <span class="c"># it as it was</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">txtFilePath</span><span class="p">,</span> <span class="n">file_path</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">txtFilePath</span><span class="p">),</span> <span class="s">'w'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
+ </div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.debug — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.debug</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+
+<span class="c"># Copyright (C) 2010-2018 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="sd">"""\</span>
+<span class="sd">This file assume DEBUG functionalities use</span>
+
+<span class="sd">- print debug messages in sys.stderr for salomeTools</span>
+<span class="sd">- show pretty print debug representation from instances of SAT classes</span>
+<span class="sd"> (pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')</span>
+
+<span class="sd">WARNING: obviously supposedly show messages in SAT development phase, not production</span>
+
+<span class="sd">usage:</span>
+<span class="sd">>> import debug as DBG</span>
+<span class="sd">>> DBG.write("aTitle", aVariable) # not shown in production </span>
+<span class="sd">>> DBG.write("aTitle", aVariable, True) # unconditionaly shown (as show=True)</span>
+
+<span class="sd">to set show message as development phase:</span>
+<span class="sd">>> DBG.push_debug(True)</span>
+
+<span class="sd">to set no show message as production phase:</span>
+<span class="sd">>> DBG.push_debug(False)</span>
+
+<span class="sd">to set show message temporary as development phase, only in a method:</span>
+<span class="sd">>> def aMethodToDebug(...):</span>
+<span class="sd">>> DBG.push_debug(True) #force show as appended status</span>
+<span class="sd">>> etc. method code with some DBG.write()</span>
+<span class="sd">>> DBG.pop_debug() #restore previous status (show or not show)</span>
+<span class="sd">>> return</span>
+
+<span class="sd">to set a message for future fix, as temporary problem to not forget:</span>
+<span class="sd">DBG.tofix("aTitle", aVariable, True/False) #True/False in production shown, or not</span>
+
+<span class="sd">in command line interface you could redirect stderr to file 'myDebug.log':</span>
+<span class="sd">>> sat compile ... 2> myDebug.log # only stderr</span>
+<span class="sd">>> sat compile ... &> myDebug.log # stdout and stderr</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">StringIO</span> <span class="kn">as</span> <span class="nn">SIO</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="kn">as</span> <span class="nn">PP</span>
+
+<span class="n">_debug</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span><span class="p">]</span> <span class="c">#support push/pop for temporary activate debug outputs</span>
+
+<div class="viewcode-block" id="indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.indent">[docs]</a><span class="k">def</span> <span class="nf">indent</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">amount</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ch</span><span class="o">=</span><span class="s">' '</span><span class="p">):</span>
+ <span class="sd">"""indent multi lines message"""</span>
+ <span class="n">padding</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">ch</span>
+ <span class="k">return</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">padding</span> <span class="o">+</span> <span class="n">line</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">text</span><span class="o">.</span><span class="n">splitlines</span><span class="p">(</span><span class="bp">True</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.write">[docs]</a><span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s">""</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s">"</span><span class="se">\n</span><span class="s">#### DEBUG: </span><span class="si">%s</span><span class="s">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">):</span>
+ <span class="sd">"""write sys.stderr a message if _debug[-1]==True or optionaly force=True"""</span>
+ <span class="k">if</span> <span class="n">_debug</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="n">force</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s">'src.pyconf.'</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)):</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">getStrConfigDbg</span><span class="p">(</span><span class="n">var</span><span class="p">))))</span>
+ <span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">str</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">var</span><span class="p">))))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">var</span><span class="p">)))</span>
+ <span class="k">return</span>
+</div>
+<div class="viewcode-block" id="tofix"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.tofix">[docs]</a><span class="k">def</span> <span class="nf">tofix</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s">""</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> write sys.stderr a message if _debug[-1]==True or optionaly force=True</span>
+<span class="sd"> use this only if no logger accessible for classic </span>
+<span class="sd"> logger.warning(message) or logger.debug(message)</span>
+<span class="sd"> """</span>
+ <span class="n">fmt</span> <span class="o">=</span> <span class="s">"</span><span class="se">\n</span><span class="s">#### TOFIX: </span><span class="si">%s</span><span class="s">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span>
+ <span class="n">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="p">,</span> <span class="n">force</span><span class="p">,</span> <span class="n">fmt</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="push_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.push_debug">[docs]</a><span class="k">def</span> <span class="nf">push_debug</span><span class="p">(</span><span class="n">aBool</span><span class="p">):</span>
+ <span class="sd">"""set debug outputs activated, or not"""</span>
+ <span class="n">_debug</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">aBool</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="pop_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.pop_debug">[docs]</a><span class="k">def</span> <span class="nf">pop_debug</span><span class="p">():</span>
+ <span class="sd">"""restore previous debug outputs status"""</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">_debug</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">_debug</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">ERROR: pop_debug: too much pop."</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">None</span>
+
+<span class="c">###############################################</span>
+<span class="c"># utilitaires divers pour debug</span>
+<span class="c">###############################################</span>
+</div>
+<div class="viewcode-block" id="OutStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.OutStream">[docs]</a><span class="k">class</span> <span class="nc">OutStream</span><span class="p">(</span><span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">):</span>
+ <span class="sd">"""utility class for pyconf.Config output iostream"""</span>
+<div class="viewcode-block" id="OutStream.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.OutStream.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""because Config.__save__ calls close() stream as file</span>
+<span class="sd"> keep value before lost as self.value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
+ <span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ </div></div>
+<div class="viewcode-block" id="InStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.InStream">[docs]</a><span class="k">class</span> <span class="nc">InStream</span><span class="p">(</span><span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">):</span>
+ <span class="sd">"""utility class for pyconf.Config input iostream"""</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="getLocalEnv"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getLocalEnv">[docs]</a><span class="k">def</span> <span class="nf">getLocalEnv</span><span class="p">():</span>
+ <span class="sd">"""get string for environment variables representation"""</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">+=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> : </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">res</span>
+
+<span class="c"># save as initial Config.save() moved as Config.__save__() </span></div>
+<div class="viewcode-block" id="saveConfigStd"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.saveConfigStd">[docs]</a><span class="k">def</span> <span class="nf">saveConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">):</span>
+ <span class="sd">"""returns as file .pyconf"""</span>
+ <span class="n">indent</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="getStrConfigStd"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigStd">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""set string as saveConfigStd, as file .pyconf"""</span>
+ <span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
+ <span class="n">saveConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span>
+</div>
+<div class="viewcode-block" id="getStrConfigDbg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigDbg">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> set string as saveConfigDbg, </span>
+<span class="sd"> as (path expression evaluation) for debug</span>
+<span class="sd"> """</span>
+ <span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
+ <span class="n">saveConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span>
+</div>
+<div class="viewcode-block" id="saveConfigDbg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.saveConfigDbg">[docs]</a><span class="k">def</span> <span class="nf">saveConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+ <span class="sd">"""pyconf returns multilines (path expression evaluation) for debug"""</span>
+ <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="c"># as config.__save__()</span>
+</div>
+<span class="k">def</span> <span class="nf">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="sd">"""pyconf inspired from Mapping.__save__"""</span>
+ <span class="n">debug</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="n">indent</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">indentp</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">indentp</span> <span class="o">=</span> <span class="n">indentp</span> <span class="o">+</span> <span class="mi">2</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span> <span class="c"># '':no indent, ' ':indent</span>
+ <span class="n">strType</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">config</span><span class="p">))</span>
+ <span class="k">if</span> <span class="s">"Sequence"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">config</span><span class="p">)):</span>
+ <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s">"[</span><span class="si">%i</span><span class="s">]"</span> <span class="o">%</span> <span class="n">i</span><span class="p">)</span>
+ <span class="k">return</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s"> : '</span><span class="si">%s</span><span class="s">'</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">config</span><span class="p">)))</span>
+ <span class="k">return</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">order</span><span class="p">):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="n">strType</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">debug</span><span class="p">:</span> <span class="k">print</span> <span class="n">indstr</span> <span class="o">+</span> <span class="s">'strType = </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">strType</span><span class="p">,</span> <span class="n">key</span>
+ <span class="k">if</span> <span class="s">"Config"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s">"."</span><span class="o">+</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="s">"Mapping"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s">"."</span><span class="o">+</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="s">"Sequence"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)):</span>
+ <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s">"."</span><span class="o">+</span><span class="n">key</span><span class="o">+</span><span class="s">"[</span><span class="si">%i</span><span class="s">]"</span> <span class="o">%</span> <span class="n">i</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="s">"Expression"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">evaluate</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : </span><span class="si">%s</span><span class="s"> --> '</span><span class="si">%s</span><span class="s">'</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">evaluate</span><span class="p">))</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : !!! ERROR: </span><span class="si">%s</span><span class="s"> !!!</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="s">"Reference"</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">evaluate</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">resolve</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : </span><span class="si">%s</span><span class="s"> --> '</span><span class="si">%s</span><span class="s">'</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">evaluate</span><span class="p">))</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : !!! ERROR: </span><span class="si">%s</span><span class="s"> !!!</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="bp">None</span><span class="p">),</span> <span class="nb">unicode</span><span class="p">]:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : '</span><span class="si">%s</span><span class="s">'</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="k">continue</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"!!! TODO fix that </span><span class="si">%s</span><span class="s"> </span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s%s</span><span class="s">.</span><span class="si">%s</span><span class="s"> : !!! </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.environment — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.environment</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+<span class="kn">import</span> <span class="nn">string</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+
+<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">import</span> <span class="nn">src.debug</span> <span class="kn">as</span> <span class="nn">DBG</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="kn">as</span> <span class="nn">PP</span>
+
+<div class="viewcode-block" id="Environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ">[docs]</a><span class="k">class</span> <span class="nc">Environ</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class to manage the environment context</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Initialization. If the environ argument is passed, the environment</span>
+<span class="sd"> will be add to it, else it is the external environment.</span>
+<span class="sd"> </span>
+<span class="sd"> :param environ dict: </span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""easy non exhaustive quick resume for debug print"""</span>
+ <span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">(</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">_expandvars</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> replace some $VARIABLE into its actual value in the environment</span>
+<span class="sd"> </span>
+<span class="sd"> :param value str: the string to be replaced</span>
+<span class="sd"> :return: the replaced variable</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">"$"</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
+ <span class="c"># The string.Template class is a string class </span>
+ <span class="c"># for supporting $-substitutions</span>
+ <span class="n">zt</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">Template</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">zt</span><span class="o">.</span><span class="n">substitute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Missing definition "</span>
+ <span class="s">"in environment: </span><span class="si">%s</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">value</span>
+
+<div class="viewcode-block" id="Environ.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> append value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str: the value to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="c"># check if the key is already in the environment</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="n">value_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span>
+ <span class="c"># Check if the value is already in the key value or not</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">value_list</span><span class="p">:</span>
+ <span class="n">value_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">value_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value_list</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">value_list</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value_list</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Environ.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Same as append_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str or list: the value(s) to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Environ.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="n">value_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">value_list</span><span class="p">:</span>
+ <span class="n">value_list</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">value_list</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">value_list</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">value_list</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value_list</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Environ.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Same as prepend_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Environ.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Check if the key exists in the environment</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to check</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Environ.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_expandvars</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Environ.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="s">""</span>
+</div>
+<div class="viewcode-block" id="Environ.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
+ <span class="n">env</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+
+</div></div>
+<div class="viewcode-block" id="SalomeEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron">[docs]</a><span class="k">class</span> <span class="nc">SalomeEnviron</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class to manage the environment of SALOME.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">cfg</span><span class="p">,</span>
+ <span class="n">environ</span><span class="p">,</span>
+ <span class="n">forBuild</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
+ <span class="n">for_package</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+ <span class="n">enable_simple_env_script</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Initialization.</span>
+
+<span class="sd"> :param cfg Config: the global config</span>
+<span class="sd"> :param environ Environ: the Environ instance where </span>
+<span class="sd"> to store the environment variables</span>
+<span class="sd"> :param forBuild bool: If true, it is a launch environment, </span>
+<span class="sd"> else a build one</span>
+<span class="sd"> :param for_package str: If not None, produce a relative environment </span>
+<span class="sd"> designed for a package. </span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="o">=</span> <span class="n">forBuild</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span> <span class="o">=</span> <span class="n">for_package</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">enable_simple_env_script</span> <span class="o">=</span> <span class="n">enable_simple_env_script</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""easy almost exhaustive quick resume for debug print"""</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s">"environ"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="s">"forBuild"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">,</span>
+ <span class="s">"for_package"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">(</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">res</span><span class="p">))</span>
+
+<div class="viewcode-block" id="SalomeEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> append value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str: the value to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Check if the key exists in the environment</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to check</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="c"># check if value needs to be evaluated</span>
+ <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"`"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"`"</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="s">"echo </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">value</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.dump"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.dump">[docs]</a> <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Write the environment to out</span>
+<span class="sd"> </span>
+<span class="sd"> :param out file: the stream where to write the environment</span>
+<span class="sd"> """</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="s">"?"</span>
+ <span class="n">out</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">=</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nb_line</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add empty lines to the out stream (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param nb_line int: the number of empty lines to add</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'add_line'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="n">nb_line</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a commentary to the out stream (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param comment str: the commentary to add</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'add_comment'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="n">comment</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a warning to the out stream (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param warning str: the warning to add</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'add_warning'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_warning</span><span class="p">(</span><span class="n">warning</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'finish'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">"clean all the path"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="n">required</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_python_libdirs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_python_libdirs">[docs]</a> <span class="k">def</span> <span class="nf">set_python_libdirs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""Set some generic variables for python library paths"""</span>
+ <span class="n">ver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'PYTHON_VERSION'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'PYTHON_LIBDIR0'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">'lib'</span><span class="p">,</span>
+ <span class="s">'python'</span> <span class="o">+</span> <span class="n">ver</span><span class="p">,</span>
+ <span class="s">'site-packages'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'PYTHON_LIBDIR1'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">'lib64'</span><span class="p">,</span>
+ <span class="s">'python'</span> <span class="o">+</span> <span class="n">ver</span><span class="p">,</span>
+ <span class="s">'site-packages'</span><span class="p">))</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">python_lib0</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'PYTHON_LIBDIR0'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">python_lib1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'PYTHON_LIBDIR1'</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.get_names"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.get_names">[docs]</a> <span class="k">def</span> <span class="nf">get_names</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lProducts</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the products name to add in SALOME_MODULES environment variable</span>
+<span class="sd"> It is the name of the product, except in the case where the is a </span>
+<span class="sd"> component name. And it has to be in SALOME_MODULES variable only </span>
+<span class="sd"> if the product has the property has_salome_hui = "yes"</span>
+<span class="sd"> </span>
+<span class="sd"> :param lProducts list: List of products to potentially add</span>
+<span class="sd"> """</span>
+ <span class="n">lProdHasGui</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">lProducts</span> <span class="k">if</span> <span class="s">'properties'</span> <span class="ow">in</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span> <span class="ow">and</span>
+ <span class="s">'has_salome_gui'</span> <span class="ow">in</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span>
+ <span class="n">p</span><span class="p">)</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">has_salome_gui</span><span class="o">==</span><span class="s">'yes'</span><span class="p">]</span>
+ <span class="n">lProdName</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">ProdName</span> <span class="ow">in</span> <span class="n">lProdHasGui</span><span class="p">:</span>
+ <span class="n">pi</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">ProdName</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s">'component_name'</span> <span class="ow">in</span> <span class="n">pi</span><span class="p">:</span>
+ <span class="n">lProdName</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pi</span><span class="o">.</span><span class="n">component_name</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">lProdName</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ProdName</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">lProdName</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_application_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_application_env">[docs]</a> <span class="k">def</span> <span class="nf">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the environment defined in the APPLICATION file.</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> """</span>
+
+ <span class="c"># add variable PRODUCT_ROOT_DIR as $workdir in APPLICATION.environ section if not present</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">PRODUCT_ROOT_DIR</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">PRODUCT_ROOT_DIR</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Reference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">DOLLAR</span><span class="p">,</span> <span class="s">"workdir"</span><span class="p">)</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"set_application_env add default Config.APPLICATION.environ.PRODUCT_ROOT_DIR"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+
+ <span class="c"># Set the variables defined in the "environ" section</span>
+ <span class="k">if</span> <span class="s">'environ'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
+ <span class="c"># we write PRODUCT environment it in order to conform to </span>
+ <span class="c"># parseConfigFile.py</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">"PRODUCT environment"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="ow">and</span> <span class="s">"build"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">build</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="ow">and</span> <span class="s">"launch"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">launch</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+
+ <span class="c"># If there is an "environ_script" section, load the scripts</span>
+ <span class="k">if</span> <span class="s">'environ_script'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">pscript</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ_script</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">"script </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">pscript</span><span class="p">)</span>
+ <span class="n">sname</span> <span class="o">=</span> <span class="n">pscript</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">" "</span><span class="p">,</span> <span class="s">"_"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_env_script</span><span class="p">(</span><span class="s">"APPLICATION_</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">sname</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ_script</span><span class="p">[</span><span class="n">pscript</span><span class="p">],</span>
+ <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_salome_minimal_product_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_minimal_product_env">[docs]</a> <span class="k">def</span> <span class="nf">set_salome_minimal_product_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product_info</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the minimal environment for a SALOME product.</span>
+<span class="sd"> xxx_ROOT_DIR and xxx_SRC_DIR</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The product description</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages </span>
+<span class="sd"> """</span>
+ <span class="c"># set root dir</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"set_salome_minimal_product_env"</span><span class="p">,</span> <span class="n">product_info</span><span class="p">)</span>
+ <span class="n">root_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"_ROOT_DIR"</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">root_dir</span><span class="p">):</span>
+ <span class="k">if</span> <span class="s">'install_dir'</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">root_dir</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" "</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s">"No install_dir for product </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+
+ <span class="n">source_in_package</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_property_in_product_cfg</span><span class="p">(</span><span class="n">product_info</span><span class="p">,</span>
+ <span class="s">"sources_in_package"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span> <span class="ow">or</span> <span class="n">source_in_package</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">:</span>
+ <span class="c"># set source dir, unless no source dir</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_fixed</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="n">src_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"_SRC_DIR"</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">src_dir</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">src_dir</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">src_dir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">"out_dir_Path"</span><span class="p">,</span>
+ <span class="s">"SOURCES"</span><span class="p">,</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_salome_generic_product_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_generic_product_env">[docs]</a> <span class="k">def</span> <span class="nf">set_salome_generic_product_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pi</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the generic environment for a SALOME product.</span>
+<span class="sd"> </span>
+<span class="sd"> :param pi Config: The product description</span>
+<span class="sd"> """</span>
+ <span class="c"># Construct XXX_ROOT_DIR</span>
+ <span class="n">env_root_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pi</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"_ROOT_DIR"</span><span class="p">)</span>
+ <span class="n">l_binpath_libpath</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="c"># create additional ROOT_DIR for CPP components</span>
+ <span class="k">if</span> <span class="s">'component_name'</span> <span class="ow">in</span> <span class="n">pi</span><span class="p">:</span>
+ <span class="n">compo_name</span> <span class="o">=</span> <span class="n">pi</span><span class="o">.</span><span class="n">component_name</span>
+ <span class="k">if</span> <span class="n">compo_name</span> <span class="o">+</span> <span class="s">"CPP"</span> <span class="o">==</span> <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
+ <span class="n">compo_root_dir</span> <span class="o">=</span> <span class="n">compo_name</span> <span class="o">+</span> <span class="s">"_ROOT_DIR"</span>
+ <span class="n">envcompo_root_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">TOOLS</span><span class="o">.</span><span class="n">common</span><span class="o">.</span><span class="n">install_root</span><span class="p">,</span> <span class="n">compo_name</span> <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">compo_root_dir</span> <span class="p">,</span> <span class="n">envcompo_root_dir</span><span class="p">)</span>
+ <span class="n">bin_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">envcompo_root_dir</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+ <span class="n">lib_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">envcompo_root_dir</span><span class="p">,</span> <span class="s">'lib'</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+ <span class="n">l_binpath_libpath</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span> <span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">get_property_in_product_cfg</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="s">"fhs"</span><span class="p">):</span>
+ <span class="n">lib_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'lib'</span><span class="p">)</span>
+ <span class="n">pylib1_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib0</span><span class="p">)</span>
+ <span class="n">pylib2_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib1</span><span class="p">)</span>
+ <span class="n">bin_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">lib_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'lib'</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+ <span class="n">pylib1_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib0</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+ <span class="n">pylib2_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib1</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+ <span class="n">bin_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">,</span> <span class="s">'salome'</span><span class="p">)</span>
+
+ <span class="c"># Construct the paths to prepend to PATH and LD_LIBRARY_PATH and </span>
+ <span class="c"># PYTHONPATH</span>
+ <span class="n">l_binpath_libpath</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span> <span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span> <span class="ow">in</span> <span class="n">l_binpath_libpath</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">bin_path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'LD_LIBRARY_PATH'</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span>
+
+ <span class="n">l</span> <span class="o">=</span> <span class="p">[</span> <span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">,</span> <span class="n">pylib1_path</span><span class="p">,</span> <span class="n">pylib2_path</span> <span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PYTHONPATH'</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_cpp_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_cpp_env">[docs]</a> <span class="k">def</span> <span class="nf">set_cpp_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the generic environment for a SALOME cpp product.</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The product description</span>
+<span class="sd"> """</span>
+ <span class="c"># Construct XXX_ROOT_DIR</span>
+ <span class="n">env_root_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"_ROOT_DIR"</span><span class="p">)</span>
+ <span class="n">l_binpath_libpath</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="c"># Construct the paths to prepend to PATH and LD_LIBRARY_PATH and </span>
+ <span class="c"># PYTHONPATH</span>
+ <span class="n">bin_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">)</span>
+ <span class="n">lib_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="s">'lib'</span><span class="p">)</span>
+ <span class="n">l_binpath_libpath</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span> <span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span> <span class="ow">in</span> <span class="n">l_binpath_libpath</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">bin_path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'LD_LIBRARY_PATH'</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">)</span>
+
+ <span class="n">l</span> <span class="o">=</span> <span class="p">[</span> <span class="n">bin_path</span><span class="p">,</span> <span class="n">lib_path</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib0</span><span class="p">),</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">env_root_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">python_lib1</span><span class="p">)</span>
+ <span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PYTHONPATH'</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.load_cfg_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.load_cfg_environment">[docs]</a> <span class="k">def</span> <span class="nf">load_cfg_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg_env</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Loads environment defined in cfg_env </span>
+<span class="sd"> </span>
+<span class="sd"> :param cfg_env Config: A config containing an environment </span>
+<span class="sd"> """</span>
+ <span class="c"># Loop on cfg_env values</span>
+ <span class="k">for</span> <span class="n">env_def</span> <span class="ow">in</span> <span class="n">cfg_env</span><span class="p">:</span>
+ <span class="n">val</span> <span class="o">=</span> <span class="n">cfg_env</span><span class="p">[</span><span class="n">env_def</span><span class="p">]</span>
+
+ <span class="c"># if it is env_script, do not do anything (reserved keyword)</span>
+ <span class="k">if</span> <span class="n">env_def</span> <span class="o">==</span> <span class="s">"env_script"</span><span class="p">:</span>
+ <span class="k">continue</span>
+
+ <span class="c"># if it is a dict, do not do anything</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">):</span>
+ <span class="k">continue</span>
+
+ <span class="c"># if it is a list, loop on its values</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">):</span>
+ <span class="c"># transform into list of strings</span>
+ <span class="n">l_val</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">val</span><span class="p">:</span>
+ <span class="n">l_val</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
+ <span class="n">val</span> <span class="o">=</span> <span class="n">l_val</span>
+
+ <span class="c"># "_" means that the value must be prepended</span>
+ <span class="k">if</span> <span class="n">env_def</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"_"</span><span class="p">):</span>
+ <span class="c"># separator exception for PV_PLUGIN_PATH</span>
+ <span class="k">if</span> <span class="n">env_def</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">==</span> <span class="s">'PV_PLUGIN_PATH'</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="n">env_def</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="n">val</span><span class="p">,</span> <span class="s">';'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="n">env_def</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="n">val</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">env_def</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"_"</span><span class="p">):</span>
+ <span class="c"># separator exception for PV_PLUGIN_PATH</span>
+ <span class="k">if</span> <span class="n">env_def</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">'PV_PLUGIN_PATH'</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">env_def</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">val</span><span class="p">,</span> <span class="s">';'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">env_def</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">val</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">env_def</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_a_product"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_a_product">[docs]</a> <span class="k">def</span> <span class="nf">set_a_product</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the environment of a product. </span>
+<span class="sd"> </span>
+<span class="sd"> :param product str: The product name</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> """</span>
+
+ <span class="c"># Get the informations corresponding to the product</span>
+ <span class="n">pi</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">product</span><span class="p">)</span>
+
+ <span class="c"># skip mesa products (if any) at run time, </span>
+ <span class="c"># unless use_mesa property was activated</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s">"APPLICATION"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="ow">and</span>
+ <span class="s">"properties"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span> <span class="ow">and</span>
+ <span class="s">"use_mesa"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">use_mesa</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span> <span class="p">:</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">pi</span> <span class="ow">and</span>
+ <span class="s">"is_mesa"</span> <span class="ow">in</span> <span class="n">pi</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_mesa</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span> <span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Skip mesa product </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="k">return</span>
+
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">:</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">"out_dir_Path"</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Setting environment for </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">product</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">'setting environ for '</span> <span class="o">+</span> <span class="n">product</span><span class="p">)</span>
+
+ <span class="c"># Do not define environment if the product is native</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_native</span><span class="p">(</span><span class="n">pi</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_has_env_script</span><span class="p">(</span><span class="n">pi</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_env_script</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="n">native</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
+ <span class="k">return</span>
+
+ <span class="c"># Set an additional environment for SALOME products</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_salome</span><span class="p">(</span><span class="n">pi</span><span class="p">):</span>
+ <span class="c"># set environment using definition of the product</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_salome_minimal_product_env</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_salome_generic_product_env</span><span class="p">(</span><span class="n">pi</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_cpp</span><span class="p">(</span><span class="n">pi</span><span class="p">):</span>
+ <span class="c"># set a specific environment for cpp modules</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_salome_minimal_product_env</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_cpp_env</span><span class="p">(</span><span class="n">pi</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_generated</span><span class="p">(</span><span class="n">pi</span><span class="p">):</span>
+ <span class="k">if</span> <span class="s">"component_name"</span> <span class="ow">in</span> <span class="n">pi</span><span class="p">:</span>
+ <span class="c"># hack the source and install directories in order to point </span>
+ <span class="c"># on the generated product source install directories</span>
+ <span class="n">install_dir_save</span> <span class="o">=</span> <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span>
+ <span class="n">source_dir_save</span> <span class="o">=</span> <span class="n">pi</span><span class="o">.</span><span class="n">source_dir</span>
+ <span class="n">name_save</span> <span class="o">=</span> <span class="n">pi</span><span class="o">.</span><span class="n">name</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="s">"INSTALL"</span><span class="p">,</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">component_name</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">:</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">"out_dir_Path"</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">component_name</span><span class="p">)</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">source_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="s">"GENERATED"</span><span class="p">,</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">component_name</span><span class="p">)</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">pi</span><span class="o">.</span><span class="n">component_name</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_salome_minimal_product_env</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_salome_generic_product_env</span><span class="p">(</span><span class="n">pi</span><span class="p">)</span>
+
+ <span class="c"># Put original values</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">install_dir_save</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">source_dir</span> <span class="o">=</span> <span class="n">source_dir_save</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name_save</span>
+
+ <span class="c"># Put the environment define in the configuration of the product</span>
+ <span class="k">if</span> <span class="s">"environ"</span> <span class="ow">in</span> <span class="n">pi</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="ow">and</span> <span class="s">"build"</span> <span class="ow">in</span> <span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">build</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="ow">and</span> <span class="s">"launch"</span> <span class="ow">in</span> <span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">load_cfg_environment</span><span class="p">(</span><span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">launch</span><span class="p">)</span>
+ <span class="c"># if product_info defines a env_scripts, load it</span>
+ <span class="k">if</span> <span class="s">'env_script'</span> <span class="ow">in</span> <span class="n">pi</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_env_script</span><span class="p">(</span><span class="n">pi</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+
+
+
+</div>
+<div class="viewcode-block" id="SalomeEnviron.run_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.run_env_script">[docs]</a> <span class="k">def</span> <span class="nf">run_env_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product_info</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">native</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Runs an environment script. </span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The product description</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> :param native Boolean: if True load set_native_env instead of set_env</span>
+<span class="sd"> """</span>
+ <span class="n">env_script</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span>
+ <span class="c"># Check that the script exists</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">env_script</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Environment script not found: </span><span class="si">%s</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">env_script</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="ow">and</span> <span class="n">logger</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">env_script</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+
+ <span class="c"># import the script and run the set_env function</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">imp</span>
+ <span class="n">pyproduct</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_source</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"_env_script"</span><span class="p">,</span>
+ <span class="n">env_script</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">native</span><span class="p">:</span>
+ <span class="n">pyproduct</span><span class="o">.</span><span class="n">set_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">,</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s">"set_nativ_env"</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">pyproduct</span><span class="p">):</span>
+ <span class="n">pyproduct</span><span class="o">.</span><span class="n">set_nativ_env</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">__</span><span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
+ <span class="k">print</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">)</span>
+ <span class="kn">import</span> <span class="nn">traceback</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_tb</span><span class="p">(</span><span class="n">exceptionTraceback</span><span class="p">)</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.run_simple_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.run_simple_env_script">[docs]</a> <span class="k">def</span> <span class="nf">run_simple_env_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script_path</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Runs an environment script. Same as run_env_script, but with a </span>
+<span class="sd"> script path as parameter.</span>
+<span class="sd"> </span>
+<span class="sd"> :param script_path str: a path to an environment script</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enable_simple_env_script</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="c"># Check that the script exists</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">script_path</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Environment script not found: </span><span class="si">%s</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">script_path</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="ow">and</span> <span class="n">logger</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">script_path</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+
+ <span class="n">script_basename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">script_path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">script_basename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".py"</span><span class="p">):</span>
+ <span class="n">script_basename</span> <span class="o">=</span> <span class="n">script_basename</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s">".py"</span><span class="p">)]</span>
+
+ <span class="c"># import the script and run the set_env function</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">imp</span>
+ <span class="n">pyproduct</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_source</span><span class="p">(</span><span class="n">script_basename</span> <span class="o">+</span> <span class="s">"_env_script"</span><span class="p">,</span>
+ <span class="n">script_path</span><span class="p">)</span>
+ <span class="n">pyproduct</span><span class="o">.</span><span class="n">load_env</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">__</span><span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
+ <span class="k">print</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">)</span>
+ <span class="kn">import</span> <span class="nn">traceback</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_tb</span><span class="p">(</span><span class="n">exceptionTraceback</span><span class="p">)</span>
+ <span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="SalomeEnviron.set_products"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_products">[docs]</a> <span class="k">def</span> <span class="nf">set_products</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">src_root</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the environment for all the products. </span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> :param src_root src: the application working directory</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">'setting environ for all products'</span><span class="p">)</span>
+
+ <span class="c"># Make sure that the python lib dirs are set after python</span>
+ <span class="k">if</span> <span class="s">"Python"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_a_product</span><span class="p">(</span><span class="s">"Python"</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_python_libdirs</span><span class="p">()</span>
+
+ <span class="c"># The loop on the products</span>
+ <span class="k">for</span> <span class="n">product</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">product</span> <span class="o">==</span> <span class="s">"Python"</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_a_product</span><span class="p">(</span><span class="n">product</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="SalomeEnviron.set_full_environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_full_environ">[docs]</a> <span class="k">def</span> <span class="nf">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">env_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Sets the full environment for products </span>
+<span class="sd"> specified in env_info dictionary. </span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> :param env_info list: the list of products</span>
+<span class="sd"> """</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"set_full_environ for"</span><span class="p">,</span> <span class="n">env_info</span><span class="p">)</span>
+ <span class="c"># DBG.write("set_full_environ config", self.cfg.APPLICATION.environ, True)</span>
+ <span class="c"># set product environ</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_python_libdirs</span><span class="p">()</span>
+
+ <span class="c"># set products</span>
+ <span class="k">for</span> <span class="n">product</span> <span class="ow">in</span> <span class="n">env_info</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_a_product</span><span class="p">(</span><span class="n">product</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+</div></div>
+<div class="viewcode-block" id="FileEnvWriter"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.FileEnvWriter">[docs]</a><span class="k">class</span> <span class="nc">FileEnvWriter</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class to dump the environment to a file.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">,</span> <span class="n">src_root</span><span class="p">,</span> <span class="n">env_info</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Initialization.</span>
+
+<span class="sd"> :param cfg Config: the global config</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> :param out_dir str: The directory path where t put the output files</span>
+<span class="sd"> :param src_root str: The application working directory</span>
+<span class="sd"> :param env_info str: The list of products to add in the files.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">out_dir</span> <span class="o">=</span> <span class="n">out_dir</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">src_root</span><span class="o">=</span> <span class="n">src_root</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span> <span class="o">=</span> <span class="n">env_info</span>
+
+<div class="viewcode-block" id="FileEnvWriter.write_env_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.FileEnvWriter.write_env_file">[docs]</a> <span class="k">def</span> <span class="nf">write_env_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">forBuild</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="n">for_package</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Create an environment file.</span>
+<span class="sd"> </span>
+<span class="sd"> :param filename str: the file path</span>
+<span class="sd"> :param forBuild bool: if true, the build environment</span>
+<span class="sd"> :param shell str: the type of file wanted (.sh, .bat)</span>
+<span class="sd"> :return: The path to the generated file</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Create environment file </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+
+ <span class="c"># create then env object</span>
+ <span class="n">env_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_dir</span><span class="p">,</span> <span class="n">filename</span><span class="p">),</span> <span class="s">"w"</span><span class="p">)</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">get_file_environ</span><span class="p">(</span><span class="n">env_file</span><span class="p">,</span>
+ <span class="n">shell</span><span class="p">,</span>
+ <span class="p">{})</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">tmp</span><span class="p">,</span> <span class="n">forBuild</span><span class="p">,</span> <span class="n">for_package</span><span class="o">=</span><span class="n">for_package</span><span class="p">)</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span>
+
+ <span class="c"># Set the environment</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># set env from the APPLICATION</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+
+ <span class="c"># The list of products to launch</span>
+ <span class="n">lProductsName</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">get_names</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s">"SALOME_MODULES"</span><span class="p">,</span> <span class="s">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
+
+ <span class="c"># set the products</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">src_root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">src_root</span><span class="p">)</span>
+
+ <span class="c"># add cleanup and close</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
+ <span class="n">env_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="n">env_file</span><span class="o">.</span><span class="n">name</span>
+ </div>
+<div class="viewcode-block" id="FileEnvWriter.write_cfgForPy_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.FileEnvWriter.write_cfgForPy_file">[docs]</a> <span class="k">def</span> <span class="nf">write_cfgForPy_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">filename</span><span class="p">,</span>
+ <span class="n">additional_env</span> <span class="o">=</span> <span class="p">{},</span>
+ <span class="n">for_package</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">with_commercial</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Append to current opened aFile a cfgForPy </span>
+<span class="sd"> environment (SALOME python launcher).</span>
+<span class="sd"> </span>
+<span class="sd"> :param filename str: the file path</span>
+<span class="sd"> :param additional_env dict: a dictionary of additional variables </span>
+<span class="sd"> to add to the environment</span>
+<span class="sd"> :param for_package str: If not None, produce a relative environment </span>
+<span class="sd"> designed for a package. </span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Create configuration file </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">filename</span><span class="o">.</span><span class="n">name</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+
+ <span class="c"># create then env object</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">get_file_environ</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span>
+ <span class="s">"cfgForPy"</span><span class="p">,</span>
+ <span class="p">{})</span>
+ <span class="c"># environment for launch</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="n">tmp</span><span class="p">,</span>
+ <span class="n">forBuild</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
+ <span class="n">for_package</span><span class="o">=</span><span class="n">for_package</span><span class="p">,</span>
+ <span class="n">enable_simple_env_script</span> <span class="o">=</span> <span class="n">with_commercial</span><span class="p">)</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># set env from PRODUCT</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+
+ <span class="c"># The list of products to launch</span>
+ <span class="n">lProductsName</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">get_names</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s">"SALOME_MODULES"</span><span class="p">,</span> <span class="s">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
+
+ <span class="c"># set the products</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">src_root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">src_root</span><span class="p">)</span>
+
+ <span class="c"># Add the additional environment if it is not empty</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">additional_env</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">additional_env</span><span class="p">:</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">variable</span><span class="p">,</span> <span class="n">additional_env</span><span class="p">[</span><span class="n">variable</span><span class="p">])</span>
+
+ <span class="c"># add cleanup and close</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
+</div></div>
+<div class="viewcode-block" id="Shell"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Shell">[docs]</a><span class="k">class</span> <span class="nc">Shell</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Definition of a Shell.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">extension</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Initialization.</span>
+
+<span class="sd"> :param name str: the shell name</span>
+<span class="sd"> :param extension str: the shell extension</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">=</span> <span class="n">extension</span>
+</div>
+<div class="viewcode-block" id="load_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.load_environment">[docs]</a><span class="k">def</span> <span class="nf">load_environment</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">build</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Loads the environment (used to run the tests, for example).</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: the global config</span>
+<span class="sd"> :param build bool: build environement if True</span>
+<span class="sd"> :param logger Logger: The logger instance to display messages</span>
+<span class="sd"> """</span>
+ <span class="n">environ</span> <span class="o">=</span> <span class="n">SalomeEnviron</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">Environ</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">),</span> <span class="n">build</span><span class="p">)</span>
+ <span class="n">environ</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
+ <span class="n">environ</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
+ <span class="n">environ</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.fileEnviron — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.fileEnviron</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="kn">as</span> <span class="nn">PP</span>
+<span class="kn">import</span> <span class="nn">src.debug</span> <span class="kn">as</span> <span class="nn">DBG</span>
+
+<span class="n">bat_header</span><span class="o">=</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">@echo off</span>
+
+<span class="s">rem The following variables are used only in case of a sat package</span>
+<span class="s">set out_dir_Path=%~dp0</span>
+<span class="s">set PRODUCT_OUT_DIR=</span><span class="si">%o</span><span class="s">ut_dir_Path%</span>
+<span class="s">set prereq_install_Path=</span><span class="si">%o</span><span class="s">ut_dir_Path%\PREREQUISITES\INSTALL</span>
+<span class="s">set prereq_build_Path=</span><span class="si">%o</span><span class="s">ut_dir_Path%\PREREQUISITES\BUILD</span>
+<span class="s">"""</span>
+
+
+<span class="n">bash_header</span><span class="o">=</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">#!/bin/bash</span>
+<span class="s">##########################################################################</span>
+<span class="s">#</span>
+<span class="s">#### cleandup ###</span>
+<span class="s"># cleanup a path (first parameter) from duplicated entries;</span>
+<span class="s"># second parameter is the separator</span>
+<span class="s">cleandup() {</span>
+<span class="s">out_var=`echo $1 | awk -v sep=$2 '{ </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> na = split($1,a,sep); </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> k=0; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> for(i=0;i<=na;i++) { </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> found=0; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> for(j=0;j<k;j++) { </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> if(a[i]==aa[j]) </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> { </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> found=1; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> break; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> }; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> }; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> if(found==0) { </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> aa[k++]=a[i]; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> }; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> }; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> ORS=sep; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> for(i=0;i<k;i++) { </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> print aa[i]; </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> } </span><span class="se">\\</span><span class="s"></span>
+<span class="s"> }' | sed -e 's|</span><span class="se">\\</span><span class="s">(.*</span><span class="se">\\</span><span class="s">)$1|</span><span class="se">\\</span><span class="s">1|g' -e 's|^[:;]||' -e 's|[:;]$||'`</span>
+<span class="s">echo $out_var</span>
+<span class="s">}</span>
+<span class="s">### clean ###</span>
+<span class="s">clean ()</span>
+<span class="s">{</span>
+<span class="s">xenv=`printenv $1`</span>
+<span class="s">out_var=`cleandup $xenv $2`</span>
+<span class="s">export $1=$out_var</span>
+<span class="s">}</span>
+
+<span class="s"># The 3 following variables are used only in case of a sat package</span>
+<span class="s">export out_dir_Path=$(cd $(dirname ${BASH_SOURCE[0]});pwd)</span>
+<span class="s">export PRODUCT_OUT_DIR=${out_dir_Path}</span>
+<span class="s">export PRODUCT_ROOT_DIR=${PRODUCT_OUT_DIR}</span>
+
+<span class="s">###########################################################################</span>
+<span class="s">"""</span>
+
+<span class="n">cfg_header</span><span class="o">=</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">[SALOME Configuration]</span>
+<span class="s">"""</span>
+
+<span class="n">Launcher_header</span><span class="o">=</span><span class="s">"""</span><span class="se">\</span>
+<span class="s"># a generated SALOME Configuration file using python syntax</span>
+<span class="s">"""</span>
+
+<div class="viewcode-block" id="get_file_environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.get_file_environ">[docs]</a><span class="k">def</span> <span class="nf">get_file_environ</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Instantiate correct FileEnvironment sub-class.</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param shell str: the type of shell syntax to use.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">shell</span> <span class="o">==</span> <span class="s">"bash"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">BashFileEnviron</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">shell</span> <span class="o">==</span> <span class="s">"bat"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">BatFileEnviron</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">shell</span> <span class="o">==</span> <span class="s">"cfgForPy"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">LauncherFileEnviron</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">shell</span> <span class="o">==</span> <span class="s">"cfg"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ContextFileEnviron</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">"FileEnviron: Unknown shell = </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">shell</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron">[docs]</a><span class="k">class</span> <span class="nc">FileEnviron</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Base class for shell environment</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> easy non exhaustive quick resume for debug print"""</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s">"output"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">,</span>
+ <span class="s">"environ"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">(</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">res</span><span class="p">))</span>
+
+
+ <span class="k">def</span> <span class="nf">_do_init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">output</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="n">environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="c">#if str(type(environ)) == "<type 'instance'>":</span>
+ <span class="k">if</span> <span class="nb">id</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span> <span class="o">==</span> <span class="nb">id</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s">"set </span><span class="si">%s</span><span class="s"> environ as python os.environ, are you sure it is safe ?"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s">"set </span><span class="si">%s</span><span class="s"> environ as COPY of python os.environ, are you sure it is safe ?"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span> <span class="c">#make a copy cvw 180320</span>
+
+<div class="viewcode-block" id="FileEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add some empty lines in the shell file</span>
+<span class="sd"> </span>
+<span class="sd"> :param number int: the number of lines to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">*</span> <span class="n">number</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a comment in the shell file</span>
+<span class="sd"> </span>
+<span class="sd"> :param comment str: the comment to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"# </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.add_echo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_echo">[docs]</a> <span class="k">def</span> <span class="nf">add_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a "echo" in the shell file</span>
+<span class="sd"> </span>
+<span class="sd"> :param text str: the text to echo</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'echo </span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">text</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a warning "echo" in the shell file</span>
+<span class="sd"> </span>
+<span class="sd"> :param warning str: the text to echo</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'echo "WARNING </span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> append value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str: the value to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Same as append_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str or list: the value(s) to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Same as prepend_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Check if the key exists in the environment</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to check</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Set the environment variable 'key' to value 'value'</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">"set is not implement for this shell!"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">'${</span><span class="si">%s</span><span class="s">}'</span> <span class="o">%</span> <span class="n">key</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">"command_value is not implement "</span>
+ <span class="s">"for this shell!"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="FileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">sep</span> <span class="o">!=</span> <span class="s">' '</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'clean </span><span class="si">%s</span><span class="s"> "</span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span>
+</div></div>
+<div class="viewcode-block" id="BashFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">BashFileEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class for bash shell.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">bash_header</span><span class="p">)</span>
+
+<div class="viewcode-block" id="BashFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'export </span><span class="si">%s</span><span class="s">="</span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+</div>
+<div class="viewcode-block" id="BashFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'export </span><span class="si">%s</span><span class="s">=$(</span><span class="si">%s</span><span class="s">)</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="BashFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">required</span><span class="p">:</span>
+ <span class="k">return</span>
+ <span class="n">FileEnviron</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="p">)</span>
+ </div></div>
+<div class="viewcode-block" id="BatFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">BatFileEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> for Windows batch shell.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">bat_header</span><span class="p">)</span>
+
+<div class="viewcode-block" id="BatFileEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="sd">"""Add a comment in the shell file</span>
+<span class="sd"> </span>
+<span class="sd"> :param comment str: the comment to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"rem </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="BatFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">'</span><span class="si">%%%s%%</span><span class="s">'</span> <span class="o">%</span> <span class="n">key</span>
+ </div>
+<div class="viewcode-block" id="BatFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'set </span><span class="si">%s</span><span class="s">=</span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+</div>
+<div class="viewcode-block" id="BatFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> > tmp.txt</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">command</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'set /p </span><span class="si">%s</span><span class="s"> =< tmp.txt</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="BatFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> In the particular windows case, do nothing</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">return</span>
+</div></div>
+<div class="viewcode-block" id="ContextFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">ContextFileEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
+ <span class="sd">"""Class for a salome context configuration file.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">cfg_header</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ContextFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">="</span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">'%({0})s'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">"command_value is not implement "</span>
+ <span class="s">"for salome context files!"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.add_echo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_echo">[docs]</a> <span class="k">def</span> <span class="nf">add_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="sd">"""Add a comment</span>
+<span class="sd"> </span>
+<span class="sd"> :param text str: the comment to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
+ <span class="sd">"""Add a warning</span>
+<span class="sd"> </span>
+<span class="sd"> :param text str: the warning to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s">"WARNING </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'ADD_TO_</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
+ <span class="sd">"""append value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str: the value to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ContextFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">return</span>
+</div></div>
+<div class="viewcode-block" id="special_path_separator"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.special_path_separator">[docs]</a><span class="k">def</span> <span class="nf">special_path_separator</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need</span>
+<span class="sd"> some exotic path separator.</span>
+<span class="sd"> This function gives the separator regarding the name of the variable</span>
+<span class="sd"> to append or prepend.</span>
+<span class="sd"> </span>
+<span class="sd"> :param name str: The name of the variable to find the separator</span>
+<span class="sd"> """</span>
+ <span class="n">special_blanks_keys</span><span class="o">=</span><span class="p">[</span><span class="s">"TCLLIBPATH"</span><span class="p">,</span> <span class="s">"TKLIBPATH"</span><span class="p">]</span>
+ <span class="n">special_semicolon_keys</span><span class="o">=</span><span class="p">[</span><span class="s">"PV_PLUGIN_PATH"</span><span class="p">]</span>
+ <span class="n">res</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">special_blanks_keys</span><span class="p">:</span> <span class="n">res</span><span class="o">=</span><span class="s">" "</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">special_semicolon_keys</span><span class="p">:</span> <span class="n">res</span><span class="o">=</span><span class="s">";"</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">LauncherFileEnviron</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class to generate a launcher file script </span>
+<span class="sd"> (in python syntax) SalomeContext API</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param output file: the output file stream.</span>
+<span class="sd"> :param environ dict: a potential additional environment.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">output</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="n">environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span>
+ <span class="c"># Initialize some variables</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"PATH"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">"PATH"</span><span class="p">]</span><span class="o">=</span><span class="s">""</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"LD_LIBRARY_PATH"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">"LD_LIBRARY_PATH"</span><span class="p">]</span><span class="o">=</span><span class="s">""</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"PYTHONPATH"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">"PYTHONPATH"</span><span class="p">]</span><span class="o">=</span><span class="s">""</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"TCLLIBPATH"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">"TCLLIBPATH"</span><span class="p">]</span><span class="o">=</span><span class="s">""</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"TKLIBPATH"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">"TKLIBPATH"</span><span class="p">]</span><span class="o">=</span><span class="s">""</span>
+
+ <span class="c"># four whitespaces for first indentation in a python script</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">=</span><span class="s">" "</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="o">=</span><span class="s">"context."</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">=</span><span class="s">"setVariable"</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">prefix</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">Launcher_header</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">specialKeys</span><span class="o">=</span><span class="p">{</span><span class="s">"PATH"</span><span class="p">:</span> <span class="s">"Path"</span><span class="p">,</span>
+ <span class="s">"LD_LIBRARY_PATH"</span><span class="p">:</span> <span class="s">"LdLibraryPath"</span><span class="p">,</span>
+ <span class="s">"PYTHONPATH"</span><span class="p">:</span> <span class="s">"PythonPath"</span><span class="p">}</span>
+
+<div class="viewcode-block" id="LauncherFileEnviron.change_to_launcher"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.change_to_launcher">[docs]</a> <span class="k">def</span> <span class="nf">change_to_launcher</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="n">res</span><span class="o">=</span><span class="n">value</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
+ <span class="sd">"""Add some empty lines in the launcher file</span>
+<span class="sd"> </span>
+<span class="sd"> :param number int: the number of lines to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">*</span> <span class="n">number</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.add_echo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_echo">[docs]</a> <span class="k">def</span> <span class="nf">add_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="sd">"""Add a comment</span>
+<span class="sd"> </span>
+<span class="sd"> :param text str: the comment to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'# </span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">text</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
+ <span class="sd">"""Add a warning</span>
+<span class="sd"> </span>
+<span class="sd"> :param text str: the warning to add</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'# "WARNING </span><span class="si">%s</span><span class="s">"</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="sd">"""append value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str: the value to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="sd">"""Same as append_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to append</span>
+<span class="sd"> :param value str or list: the value(s) to append to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="sd">"""prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="sd">"""Same as prepend_value but the value argument can be a list</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
+<span class="sd"> :param sep str: the separator string</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""Check if the key exists in the environment</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to check</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""Get the value of the environment variable "key"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">'${</span><span class="si">%s</span><span class="s">}'</span> <span class="o">%</span> <span class="n">key</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""Set the environment variable "key" to value "value"</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to set</span>
+<span class="sd"> :param value str: the value</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">+</span>
+ <span class="s">'(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">", overwrite=True)</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span>
+ <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+ </div>
+<div class="viewcode-block" id="LauncherFileEnviron.add"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""prepend value to key using sep</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable to prepend</span>
+<span class="sd"> :param value str: the value to prepend to key</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">specialKeys</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span><span class="s">'addTo</span><span class="si">%s</span><span class="s">(r"</span><span class="si">%s</span><span class="s">")</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span>
+ <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">specialKeys</span><span class="p">[</span><span class="n">key</span><span class="p">],</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">+=</span><span class="s">":"</span><span class="o">+</span><span class="n">value</span>
+ <span class="k">return</span>
+ <span class="n">sep</span><span class="o">=</span><span class="n">special_path_separator</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span>
+ <span class="s">'#temporary solution!!! have to be defined in API a '</span>
+ <span class="s">'?dangerous? addToSpecial(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">")</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span>
+ <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+ <span class="c">#pathsep not precised because do not know future os launch?</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span><span class="s">'addToSpecial(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">")</span><span class="se">\n</span><span class="s">'</span>
+ <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">+=</span><span class="n">sep</span><span class="o">+</span><span class="n">value</span> <span class="c">#here yes we know os for current execution</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> </span>
+<span class="sd"> :param key str: the environment variable</span>
+<span class="sd"> :param command str: the command to execute</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="s">'#`</span><span class="si">%s</span><span class="s">`</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
+
+ <span class="kn">import</span> <span class="nn">shlex</span><span class="o">,</span> <span class="nn">subprocess</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+ <span class="n">res</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
+ <span class="n">out</span><span class="p">,</span> <span class="n">__</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">+</span>
+ <span class="s">'(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">", overwrite=True)</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">out</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="c"># Special comment in case of the distène licence</span>
+ <span class="k">if</span> <span class="n">comment</span><span class="o">==</span><span class="s">"DISTENE license"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span>
+ <span class="s">"#"</span><span class="o">+</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="o">+</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">+</span>
+ <span class="s">'(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">", overwrite=True)</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span>
+ <span class="p">(</span><span class="s">'DISTENE_LICENSE_FILE'</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span>
+ <span class="s">'Use global envvar: DLIM8VAR'</span><span class="p">)))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span>
+ <span class="s">"#"</span><span class="o">+</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="o">+</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">+</span>
+ <span class="s">'(r"</span><span class="si">%s</span><span class="s">", r"</span><span class="si">%s</span><span class="s">", overwrite=True)</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span>
+ <span class="p">(</span><span class="s">'DLIM8VAR'</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span>
+ <span class="s">'<your licence>'</span><span class="p">)))</span>
+ <span class="k">return</span>
+ <span class="k">if</span> <span class="s">"setting environ for"</span> <span class="ow">in</span> <span class="n">comment</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="s">"#[</span><span class="si">%s</span><span class="s">]</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span>
+ <span class="n">comment</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"setting environ for "</span><span class="p">)[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">return</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="s">"# </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LauncherFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> In the particular launcher case, do nothing</span>
+<span class="sd"> </span>
+<span class="sd"> :param required bool: Do nothing if required is False</span>
+<span class="sd"> """</span>
+ <span class="k">return</span>
+</div></div>
+<div class="viewcode-block" id="ScreenEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron">[docs]</a><span class="k">class</span> <span class="nc">ScreenEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">defined</span> <span class="o">=</span> <span class="p">{}</span>
+
+<div class="viewcode-block" id="ScreenEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.add_echo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_echo">[docs]</a> <span class="k">def</span> <span class="nf">add_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sign</span><span class="o">=</span><span class="s">"="</span><span class="p">):</span>
+ <span class="kn">import</span> <span class="nn">src</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" </span><span class="si">%s%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">command</span><span class="p">),</span>
+ <span class="s">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">12</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">command</span><span class="p">)),</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcInfo</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="n">sign</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">defined</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">"${</span><span class="si">%s</span><span class="s">}"</span> <span class="o">%</span> <span class="n">name</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"set"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">defined</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"prepend"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">":"</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="n">value</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"append"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ScreenEnviron.run_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.run_env_script">[docs]</a> <span class="k">def</span> <span class="nf">run_env_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">script</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"load"</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="s">""</span><span class="p">,</span> <span class="n">sign</span><span class="o">=</span><span class="s">""</span><span class="p">)</span>
+
+<span class="c"># The SALOME launcher template </span></div></div>
+<span class="n">withProfile</span> <span class="o">=</span> <span class="s">"""</span><span class="se">\</span>
+<span class="s"> #! /usr/bin/env python</span>
+
+<span class="s">################################################################</span>
+<span class="s"># WARNING: this file is automatically generated by SalomeTools #</span>
+<span class="s"># WARNING: and so could be overwritten at any time. #</span>
+<span class="s">################################################################</span>
+
+<span class="s">import os</span>
+<span class="s">import sys</span>
+<span class="s">import subprocess</span>
+
+
+<span class="s"># Add the pwdPath to able to run the launcher after unpacking a package</span>
+<span class="s"># Used only in case of a salomeTools package</span>
+<span class="s">out_dir_Path=os.path.abspath(os.path.dirname(__file__))</span>
+
+<span class="s"># Preliminary work to initialize path to SALOME Python modules</span>
+<span class="s">def __initialize():</span>
+
+<span class="s"> sys.path[:0] = [ 'BIN_KERNEL_INSTALL_DIR' ]</span>
+<span class="s"> os.environ['ABSOLUTE_APPLI_PATH'] = 'KERNEL_INSTALL_DIR'</span>
+<span class="s"> </span>
+<span class="s"> # define folder to store omniorb config (initially in virtual application folder)</span>
+<span class="s"> try:</span>
+<span class="s"> from salomeContextUtils import setOmniOrbUserPath</span>
+<span class="s"> setOmniOrbUserPath()</span>
+<span class="s"> except Exception, e:</span>
+<span class="s"> print e</span>
+<span class="s"> sys.exit(1)</span>
+<span class="s"># End of preliminary work</span>
+
+<span class="s"># salome doc only works for virtual applications. Therefore we overwrite it with this function</span>
+<span class="s">def _showDoc(modules):</span>
+<span class="s"> for module in modules:</span>
+<span class="s"> modulePath = os.getenv(module+"_ROOT_DIR")</span>
+<span class="s"> if modulePath != None:</span>
+<span class="s"> baseDir = os.path.join(modulePath, "share", "doc", "salome")</span>
+<span class="s"> docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")</span>
+<span class="s"> if not os.path.isfile(docfile):</span>
+<span class="s"> docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")</span>
+<span class="s"> if not os.path.isfile(docfile):</span>
+<span class="s"> docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")</span>
+<span class="s"> if os.path.isfile(docfile):</span>
+<span class="s"> out, err = subprocess.Popen(["xdg-open", docfile]).communicate()</span>
+<span class="s"> else:</span>
+<span class="s"> print "Online documentation is not accessible for module:", module</span>
+<span class="s"> else:</span>
+<span class="s"> print module+"_ROOT_DIR not found!"</span>
+
+<span class="s">def main(args):</span>
+<span class="s"> # Identify application path then locate configuration files</span>
+<span class="s"> __initialize()</span>
+
+<span class="s"> if args == ['--help']:</span>
+<span class="s"> from salomeContext import usage</span>
+<span class="s"> usage()</span>
+<span class="s"> sys.exit(0)</span>
+
+<span class="s"> #from salomeContextUtils import getConfigFileNames</span>
+<span class="s"> #configFileNames, args, unexisting = getConfigFileNames( args, checkExistence=True )</span>
+<span class="s"> #if len(unexisting) > 0:</span>
+<span class="s"> # print "ERROR: unexisting configuration file(s): " + ', '.join(unexisting)</span>
+<span class="s"> # sys.exit(1)</span>
+
+<span class="s"> # Create a SalomeContext which parses configFileNames to initialize environment</span>
+<span class="s"> try:</span>
+<span class="s"> from salomeContext import SalomeContext, SalomeContextException</span>
+<span class="s"> SalomeContext.addToSpecial=addToSpecial</span>
+<span class="s"> context = SalomeContext(None)</span>
+<span class="s"> </span>
+<span class="s"> # Here set specific variables, if needed</span>
+<span class="s"> # context.addToPath('mypath')</span>
+<span class="s"> # context.addToLdLibraryPath('myldlibrarypath')</span>
+<span class="s"> # context.addToPythonPath('mypythonpath')</span>
+<span class="s"> # context.setVariable('myvarname', 'value')</span>
+
+<span class="s"> # Logger level error</span>
+<span class="s"> context.getLogger().setLevel(40)</span>
+
+<span class="s"> context.setVariable(r"PRODUCT_ROOT_DIR", out_dir_Path, overwrite=True)</span>
+<span class="s"> # here your local standalone environment</span>
+
+<span class="s"> if len(args) >1 and args[0]=='doc':</span>
+<span class="s"> _showDoc(args[1:])</span>
+<span class="s"> return</span>
+
+<span class="s"> # Start SALOME, parsing command line arguments</span>
+<span class="s"> context.runSalome(args)</span>
+<span class="s"> #print 'Thank you for using SALOME!'</span>
+
+<span class="s"> # Logger level info</span>
+<span class="s"> context.getLogger().setLevel(20)</span>
+
+<span class="s"> except SalomeContextException, e:</span>
+<span class="s"> import logging</span>
+<span class="s"> logging.getLogger("salome").error(e)</span>
+<span class="s"> sys.exit(1)</span>
+<span class="s">#</span>
+<span class="s">def addToSpecial(self, name, value, pathSep=None):</span>
+<span class="s"> # add special dangerous cases: TCLLIBPATH PV_PLUGIN_PATH etc...</span>
+<span class="s"> # http://computer-programming-forum.com/57-tcl/1dfddc136afccb94.htm</span>
+<span class="s"> # TCLLIBPATH: Tcl treats the contents of that variable as a list. Be happy, for you can now use drive letters on windows.</span>
+<span class="s"> if value == '':</span>
+<span class="s"> return</span>
+<span class="s"> </span>
+<span class="s"> specialBlanksKeys=["TCLLIBPATH", "TKLIBPATH"]</span>
+<span class="s"> specialSemicolonKeys=["PV_PLUGIN_PATH"]</span>
+<span class="s"> res=os.pathsep</span>
+<span class="s"> if name in specialBlanksKeys: res=" "</span>
+<span class="s"> if name in specialSemicolonKeys: res=";"</span>
+<span class="s"> </span>
+<span class="s"> if pathSep==None:</span>
+<span class="s"> sep=res</span>
+<span class="s"> else:</span>
+<span class="s"> sep=pathSep</span>
+<span class="s"> value = os.path.expandvars(value) # expand environment variables</span>
+<span class="s"> self.getLogger().debug("Add to </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">", name, value)</span>
+<span class="s"> env = os.getenv(name, None)</span>
+<span class="s"> if env is None:</span>
+<span class="s"> os.environ[name] = value</span>
+<span class="s"> else:</span>
+<span class="s"> os.environ[name] = value + sep + env #explicitely or not special path separator ?whitespace, semicolon?</span>
+
+<span class="s">if __name__ == "__main__":</span>
+<span class="s"> args = sys.argv[1:]</span>
+<span class="s"> main(args)</span>
+<span class="s">#</span>
+<span class="s">"""</span>
+
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.fork — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.fork</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">time</span>
+<span class="kn">import</span> <span class="nn">pickle</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+
+<div class="viewcode-block" id="show_progress"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.show_progress">[docs]</a><span class="k">def</span> <span class="nf">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="n">ss</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+ <span class="sd">"""shortcut function to display the progression</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logging instance</span>
+<span class="sd"> :param top int: the number to display</span>
+<span class="sd"> :param delai int: the number max</span>
+<span class="sd"> :param ss str: the string to display</span>
+<span class="sd"> """</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> / </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">((</span><span class="s">" "</span> <span class="o">*</span> <span class="mi">30</span><span class="p">),</span> <span class="n">ss</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="p">(</span><span class="n">delai</span> <span class="o">-</span> <span class="n">top</span><span class="p">)),</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="bp">False</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="write_back"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.write_back">[docs]</a><span class="k">def</span> <span class="nf">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="p">):</span>
+ <span class="sd">"""shortcut function to write at the begin of the line</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger Logger: The logging instance</span>
+<span class="sd"> :param message str: the text to display</span>
+<span class="sd"> :param level int: the level of verbosity</span>
+<span class="sd"> """</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">((</span><span class="s">" "</span> <span class="o">*</span> <span class="mi">40</span><span class="p">),</span> <span class="n">message</span><span class="p">),</span> <span class="n">level</span><span class="p">)</span>
+
+<span class="c"># Launch command</span>
+<span class="c"># --------------</span></div>
+<div class="viewcode-block" id="launch_command"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.launch_command">[docs]</a><span class="k">def</span> <span class="nf">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[],</span> <span class="n">log</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">log</span><span class="p">:</span>
+ <span class="n">log</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="n">log</span><span class="p">,</span> <span class="s">"a"</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"launch: </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">screenOnly</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" "</span> <span class="o">+</span> <span class="n">arg</span>
+ <span class="n">prs</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">log</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="n">cwd</span><span class="p">,</span>
+ <span class="n">executable</span><span class="o">=</span><span class="s">'/bin/bash'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">prs</span>
+
+<span class="c"># Launch a batch</span>
+<span class="c"># --------------</span></div>
+<div class="viewcode-block" id="batch"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.batch">[docs]</a><span class="k">def</span> <span class="nf">batch</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[],</span> <span class="n">log</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">delai</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">sommeil</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="n">proc</span> <span class="o">=</span> <span class="n">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">log</span><span class="p">)</span>
+ <span class="n">top</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">softspace</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="n">begin</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+ <span class="k">while</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">begin</span> <span class="o">>=</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="s">"batch:"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">top</span> <span class="o">==</span> <span class="n">delai</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"batch: time out KILL</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="kn">import</span> <span class="nn">signal</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">kill</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">)</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">begin</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">sommeil</span><span class="p">)</span>
+ <span class="n">top</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s">"batch: exit (</span><span class="si">%s</span><span class="s">)</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">returncode</span><span class="p">),</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">),</span> <span class="n">top</span>
+
+<span class="c"># Launch a salome process</span>
+<span class="c"># -----------------------</span></div>
+<div class="viewcode-block" id="batch_salome"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.batch_salome">[docs]</a><span class="k">def</span> <span class="nf">batch_salome</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">getTmpDir</span><span class="p">,</span>
+ <span class="n">pendant</span><span class="o">=</span><span class="s">"SALOME_Session_Server"</span><span class="p">,</span> <span class="n">fin</span><span class="o">=</span><span class="s">"killSalome.py"</span><span class="p">,</span>
+ <span class="n">log</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">delai</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">sommeil</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">delaiapp</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+
+ <span class="n">beginTime</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+ <span class="n">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">log</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">delaiapp</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">delaiapp</span> <span class="o">=</span> <span class="n">delai</span>
+
+ <span class="c"># first launch salome (looking for .pidict file)</span>
+ <span class="n">top</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">tmp_dir</span> <span class="o">=</span> <span class="n">getTmpDir</span><span class="p">()</span>
+ <span class="k">while</span> <span class="p">(</span><span class="ow">not</span> <span class="n">found</span> <span class="ow">and</span> <span class="n">top</span> <span class="o"><</span> <span class="n">delaiapp</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">):</span>
+ <span class="n">listFile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">listFile</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="k">for</span> <span class="n">file_name</span> <span class="ow">in</span> <span class="n">listFile</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">file_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"pidict"</span><span class="p">):</span>
+ <span class="c"># sometime we get a old file that will be removed by runSalome.</span>
+ <span class="c"># So we test that we can read it.</span>
+ <span class="n">currentTime</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">statinfo</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">,</span> <span class="n">file_name</span><span class="p">))</span>
+ <span class="n">currentTime</span> <span class="o">=</span> <span class="n">statinfo</span><span class="o">.</span><span class="n">st_mtime</span>
+ <span class="k">except</span><span class="p">:</span> <span class="k">pass</span>
+
+ <span class="k">if</span> <span class="n">currentTime</span> <span class="ow">and</span> <span class="n">currentTime</span> <span class="o">></span> <span class="n">beginTime</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">file_</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">,</span> <span class="n">file_name</span><span class="p">),</span> <span class="s">"r"</span><span class="p">)</span>
+ <span class="n">process_ids</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">file_</span><span class="p">)</span>
+ <span class="n">file_</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">process_id</span> <span class="ow">in</span> <span class="n">process_ids</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">__</span><span class="p">,</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">process_id</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">cmd</span> <span class="o">==</span> <span class="p">[</span><span class="n">pendant</span><span class="p">]:</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="n">pidictFile</span> <span class="o">=</span> <span class="n">file_name</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">file_</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">sommeil</span><span class="p">)</span>
+ <span class="n">top</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="n">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delaiapp</span><span class="p">,</span> <span class="s">"launching salome or appli:"</span><span class="p">)</span>
+
+ <span class="c"># continue or not</span>
+ <span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+ <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s">"batch_salome: started</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"batch_salome: FAILED to launch salome or appli</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span>
+
+ <span class="c"># salome launched run the script</span>
+ <span class="n">top</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">while</span> <span class="n">code</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="s">"running salome or appli:"</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">,</span> <span class="n">pidictFile</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">F_OK</span><span class="p">):</span>
+ <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s">"batch_salome: exit</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">top</span> <span class="o">>=</span> <span class="n">delai</span><span class="p">:</span>
+ <span class="c"># timeout kill the test</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">fin</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"batch_salome: time out KILL</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># still waiting</span>
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">sommeil</span><span class="p">)</span>
+ <span class="n">top</span> <span class="o">=</span> <span class="n">top</span> <span class="o">+</span> <span class="mi">1</span>
+
+ <span class="k">return</span> <span class="n">code</span><span class="p">,</span> <span class="n">top</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.logger — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.logger</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2012 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="sd">"""\</span>
+<span class="sd">Implements the classes and method relative to the logging</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">datetime</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">tempfile</span>
+
+<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">printcolors</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">xmlManager</span>
+
+<span class="n">log_macro_command_file_expression</span> <span class="o">=</span> <span class="s">"^[0-9]{8}_+[0-9]{6}_+.*\.xml$"</span>
+<span class="n">log_all_command_file_expression</span> <span class="o">=</span> <span class="s">"^.*[0-9]{8}_+[0-9]{6}_+.*\.xml$"</span>
+
+<div class="viewcode-block" id="Logger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger">[docs]</a><span class="k">class</span> <span class="nc">Logger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class to handle log mechanism.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">config</span><span class="p">,</span>
+ <span class="n">silent_sysstd</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
+ <span class="n">all_in_terminal</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
+ <span class="n">micro_command</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param config pyconf.Config: The global configuration.</span>
+<span class="sd"> :param silent_sysstd boolean: if True, do not write anything</span>
+<span class="sd"> in terminal.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">default_level</span> <span class="o">=</span> <span class="mi">3</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span> <span class="o">=</span> <span class="n">silent_sysstd</span>
+
+ <span class="c"># Construct xml log file location for sat prints.</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">if</span> <span class="n">micro_command</span><span class="p">:</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="s">"micro_"</span>
+ <span class="n">hour_command_host</span> <span class="o">=</span> <span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span> <span class="o">+</span> <span class="s">"_"</span> <span class="o">+</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span> <span class="o">+</span> <span class="s">"_"</span> <span class="o">+</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
+ <span class="n">logFileName</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">hour_command_host</span> <span class="o">+</span> <span class="s">".xml"</span>
+ <span class="n">log_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_log_path</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">logFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">log_dir</span><span class="p">,</span> <span class="n">logFileName</span><span class="p">)</span>
+ <span class="c"># Construct txt file location in order to log </span>
+ <span class="c"># the external commands calls (cmake, make, git clone, etc...)</span>
+ <span class="n">txtFileName</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">hour_command_host</span> <span class="o">+</span> <span class="s">".txt"</span>
+ <span class="n">txtFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">log_dir</span><span class="p">,</span> <span class="s">"OUT"</span><span class="p">,</span> <span class="n">txtFileName</span><span class="p">)</span>
+
+ <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">))</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">txtFilePath</span><span class="p">))</span>
+
+ <span class="c"># The path of the log files (one for sat traces, and the other for </span>
+ <span class="c"># the system commands traces)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logFileName</span> <span class="o">=</span> <span class="n">logFileName</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logFilePath</span> <span class="o">=</span> <span class="n">logFilePath</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">txtFileName</span> <span class="o">=</span> <span class="n">txtFileName</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">txtFilePath</span> <span class="o">=</span> <span class="n">txtFilePath</span>
+
+ <span class="c"># The list of all log files corresponding to the current command and</span>
+ <span class="c"># the commands called by the current command</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">l_logFiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">logFilePath</span><span class="p">,</span> <span class="n">txtFilePath</span><span class="p">]</span>
+
+ <span class="c"># Initialize xml instance and put first fields </span>
+ <span class="c"># like beginTime, user, command, etc... </span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span> <span class="o">=</span> <span class="n">xmlManager</span><span class="o">.</span><span class="n">XmlLogFile</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">,</span> <span class="s">"SATcommand"</span><span class="p">,</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s">"application"</span> <span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">})</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">put_initial_xml_fields</span><span class="p">()</span>
+ <span class="c"># Initialize the txt file for reading</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">txtFilePath</span><span class="p">),</span> <span class="s">'w'</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
+ <span class="c">#msg1 = _("WARNING! Trying to write to a file that"</span>
+ <span class="c"># " is not accessible:")</span>
+ <span class="c">#msg2 = _("The logs won't be written.")</span>
+ <span class="c">#print("%s\n%s\n%s\n" % (src.printcolors.printcWarning(msg1),</span>
+ <span class="c"># src.printcolors.printcLabel(str(self.txtFilePath)),</span>
+ <span class="c"># src.printcolors.printcWarning(msg2) ))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryFile</span><span class="p">()</span>
+
+ <span class="c"># If the option all_in_terminal was called, all the system commands</span>
+ <span class="c"># are redirected to the terminal</span>
+ <span class="k">if</span> <span class="n">all_in_terminal</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">__stdout__</span>
+
+<div class="viewcode-block" id="Logger.put_initial_xml_fields"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.put_initial_xml_fields">[docs]</a> <span class="k">def</span> <span class="nf">put_initial_xml_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Called at class initialization: Put all fields </span>
+<span class="sd"> corresponding to the command context (user, time, ...)</span>
+<span class="sd"> """</span>
+ <span class="c"># command name</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"command"</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span><span class="p">})</span>
+ <span class="c"># version of salomeTools</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"satversion"</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">INTERNAL</span><span class="o">.</span><span class="n">sat_version</span><span class="p">})</span>
+ <span class="c"># machine name on which the command has been launched</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"hostname"</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">hostname</span><span class="p">})</span>
+ <span class="c"># Distribution of the machine</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"OS"</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist</span><span class="p">})</span>
+ <span class="c"># The user that have launched the command</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"user"</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">user</span><span class="p">})</span>
+ <span class="c"># The time when command was launched</span>
+ <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span> <span class="o">=</span> <span class="n">date_to_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span><span class="p">)</span>
+ <span class="n">date_hour</span> <span class="o">=</span> <span class="s">"</span><span class="si">%2s</span><span class="s">/</span><span class="si">%2s</span><span class="s">/</span><span class="si">%4s</span><span class="s"> </span><span class="si">%2s</span><span class="s">h</span><span class="si">%2s</span><span class="s">m</span><span class="si">%2s</span><span class="s">s"</span> <span class="o">%</span> <span class="p">(</span><span class="n">dd</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"beginTime"</span> <span class="p">:</span>
+ <span class="n">date_hour</span><span class="p">})</span>
+ <span class="c"># The application if any</span>
+ <span class="k">if</span> <span class="s">"APPLICATION"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span>
+ <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"application"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">})</span>
+ <span class="c"># The initialization of the trace node</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s">"Log"</span><span class="p">,</span><span class="n">text</span><span class="o">=</span><span class="s">""</span><span class="p">)</span>
+ <span class="c"># The system commands logs</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s">"OutLog"</span><span class="p">,</span>
+ <span class="n">text</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s">"OUT"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">txtFileName</span><span class="p">))</span>
+ <span class="c"># The initialization of the node where </span>
+ <span class="c"># to put the links to the other sat commands that can be called by any</span>
+ <span class="c"># command </span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s">"Links"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Logger.add_link"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.add_link">[docs]</a> <span class="k">def</span> <span class="nf">add_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">log_file_name</span><span class="p">,</span>
+ <span class="n">command_name</span><span class="p">,</span>
+ <span class="n">command_res</span><span class="p">,</span>
+ <span class="n">full_launched_command</span><span class="p">):</span>
+ <span class="sd">"""Add a link to another log file.</span>
+<span class="sd"> </span>
+<span class="sd"> :param log_file_name str: The file name of the link.</span>
+<span class="sd"> :param command_name str: The name of the command linked.</span>
+<span class="sd"> :param command_res str: The result of the command linked. "0" or "1"</span>
+<span class="sd"> :parma full_launched_command str: The full lanch command </span>
+<span class="sd"> ("sat command ...")</span>
+<span class="sd"> """</span>
+ <span class="n">xmlLinks</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Links"</span><span class="p">)</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="n">xmlLinks</span><span class="p">,</span>
+ <span class="s">"link"</span><span class="p">,</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="n">log_file_name</span><span class="p">,</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s">"command"</span> <span class="p">:</span> <span class="n">command_name</span><span class="p">,</span>
+ <span class="s">"passed"</span> <span class="p">:</span> <span class="n">command_res</span><span class="p">,</span>
+ <span class="s">"launchedCommand"</span> <span class="p">:</span> <span class="n">full_launched_command</span><span class="p">})</span>
+</div>
+<div class="viewcode-block" id="Logger.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">screenOnly</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> function used in the commands </span>
+<span class="sd"> to print in the terminal and the log file.</span>
+<span class="sd"> </span>
+<span class="sd"> :param message str: The message to print.</span>
+<span class="sd"> :param level int: The output level corresponding </span>
+<span class="sd"> to the message 0 < level < 6.</span>
+<span class="sd"> :param screenOnly boolean: if True, do not write in log file.</span>
+<span class="sd"> """</span>
+ <span class="c"># do not write message starting with \r to log file</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"</span><span class="se">\r</span><span class="s">"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">screenOnly</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_text</span><span class="p">(</span><span class="s">"Log"</span><span class="p">,</span>
+ <span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">))</span>
+
+ <span class="c"># get user or option output level</span>
+ <span class="n">current_output_verbose_level</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
+ <span class="c"># clean the message color if the terminal is redirected by user</span>
+ <span class="c"># ex: sat compile appli > log.txt</span>
+ <span class="n">message</span> <span class="o">=</span> <span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+
+ <span class="c"># Print message regarding the output level value</span>
+ <span class="k">if</span> <span class="n">level</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">level</span> <span class="o"><=</span> <span class="n">current_output_verbose_level</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_level</span> <span class="o"><=</span> <span class="n">current_output_verbose_level</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Logger.error"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.error">[docs]</a> <span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
+ <span class="sd">"""Print an error.</span>
+<span class="sd"> </span>
+<span class="sd"> :param message str: The message to print.</span>
+<span class="sd"> """</span>
+ <span class="c"># Print in the log file</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_text</span><span class="p">(</span><span class="s">"traces"</span><span class="p">,</span> <span class="n">_</span><span class="p">(</span><span class="s">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span>
+
+ <span class="c"># Print in the terminal and clean colors if the terminal </span>
+ <span class="c"># is redirected by user</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Logger.flush"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""Flush terminal"""</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ </div>
+<div class="viewcode-block" id="Logger.end_write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.end_write">[docs]</a> <span class="k">def</span> <span class="nf">end_write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attribute</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Called just after command end: Put all fields </span>
+<span class="sd"> corresponding to the command end context (time).</span>
+<span class="sd"> Write the log xml file on the hard drive.</span>
+<span class="sd"> And display the command to launch to get the log</span>
+<span class="sd"> </span>
+<span class="sd"> :param attribute dict: the attribute to add to the node "Site".</span>
+<span class="sd"> """</span>
+ <span class="c"># Get current time (end of command) and format it</span>
+ <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
+ <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span> <span class="o">=</span> <span class="n">date_to_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span><span class="p">)</span>
+ <span class="n">t0</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">Y</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">dd</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">H</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">M</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">S</span><span class="p">))</span>
+ <span class="n">tf</span> <span class="o">=</span> <span class="n">dt</span>
+ <span class="n">delta</span> <span class="o">=</span> <span class="n">tf</span> <span class="o">-</span> <span class="n">t0</span>
+ <span class="n">total_time</span> <span class="o">=</span> <span class="n">timedelta_total_seconds</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span>
+ <span class="n">hours</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">total_time</span> <span class="o">/</span> <span class="mi">3600</span><span class="p">)</span>
+ <span class="n">minutes</span> <span class="o">=</span> <span class="nb">int</span><span class="p">((</span><span class="n">total_time</span> <span class="o">-</span> <span class="n">hours</span><span class="o">*</span><span class="mi">3600</span><span class="p">)</span> <span class="o">/</span> <span class="mi">60</span><span class="p">)</span>
+ <span class="n">seconds</span> <span class="o">=</span> <span class="n">total_time</span> <span class="o">-</span> <span class="n">hours</span><span class="o">*</span><span class="mi">3600</span> <span class="o">-</span> <span class="n">minutes</span><span class="o">*</span><span class="mi">60</span>
+ <span class="c"># Add the fields corresponding to the end time</span>
+ <span class="c"># and the total time of command</span>
+ <span class="n">endtime</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">'%Y/%m/</span><span class="si">%d</span><span class="s"> %Hh%Mm%Ss'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"endTime"</span> <span class="p">:</span> <span class="n">endtime</span><span class="p">})</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span>
+ <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s">"TotalTime"</span> <span class="p">:</span> <span class="s">"</span><span class="si">%i</span><span class="s">h</span><span class="si">%i</span><span class="s">m</span><span class="si">%i</span><span class="s">s"</span> <span class="o">%</span> <span class="p">(</span><span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span><span class="p">)})</span>
+
+ <span class="c"># Add the attribute passed to the method</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="n">attribute</span><span class="p">)</span>
+
+ <span class="c"># Call the method to write the xml file on the hard drive</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">write_tree</span><span class="p">(</span><span class="n">stylesheet</span> <span class="o">=</span> <span class="s">"command.xsl"</span><span class="p">)</span>
+
+ <span class="c"># Dump the config in a pyconf file in the log directory</span>
+ <span class="n">logDir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_log_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">dumpedPyconfFileName</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span>
+ <span class="o">+</span> <span class="s">"_"</span>
+ <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span>
+ <span class="o">+</span> <span class="s">".pyconf"</span><span class="p">)</span>
+ <span class="n">dumpedPyconfFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="s">'OUT'</span><span class="p">,</span> <span class="n">dumpedPyconfFileName</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">dumpedPyconfFilePath</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
+ <span class="k">pass</span>
+</div></div>
+<div class="viewcode-block" id="date_to_datetime"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.date_to_datetime">[docs]</a><span class="k">def</span> <span class="nf">date_to_datetime</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> From a string date in format YYYYMMDD_HHMMSS</span>
+<span class="sd"> returns list year, mon, day, hour, minutes, seconds </span>
+<span class="sd"> </span>
+<span class="sd"> :param date str: The date in format YYYYMMDD_HHMMSS</span>
+<span class="sd"> :return: the same date and time in separate variables.</span>
+<span class="sd"> :rtype: (str,str,str,str,str,str)</span>
+<span class="sd"> """</span>
+ <span class="n">Y</span> <span class="o">=</span> <span class="n">date</span><span class="p">[:</span><span class="mi">4</span><span class="p">]</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">]</span>
+ <span class="n">dd</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">]</span>
+ <span class="n">H</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">9</span><span class="p">:</span><span class="mi">11</span><span class="p">]</span>
+ <span class="n">M</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">11</span><span class="p">:</span><span class="mi">13</span><span class="p">]</span>
+ <span class="n">S</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span>
+</div>
+<div class="viewcode-block" id="timedelta_total_seconds"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.timedelta_total_seconds">[docs]</a><span class="k">def</span> <span class="nf">timedelta_total_seconds</span><span class="p">(</span><span class="n">timedelta</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Replace total_seconds from datetime module </span>
+<span class="sd"> in order to be compatible with old python versions</span>
+<span class="sd"> </span>
+<span class="sd"> :param timedelta datetime.timedelta: The delta between two dates</span>
+<span class="sd"> :return: The number of seconds corresponding to timedelta.</span>
+<span class="sd"> :rtype: float</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span>
+ <span class="n">timedelta</span><span class="o">.</span><span class="n">microseconds</span> <span class="o">+</span> <span class="mf">0.0</span> <span class="o">+</span>
+ <span class="p">(</span><span class="n">timedelta</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="n">timedelta</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span>
+ </div>
+<div class="viewcode-block" id="show_command_log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.show_command_log">[docs]</a><span class="k">def</span> <span class="nf">show_command_log</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Used in updateHatXml. </span>
+<span class="sd"> Determine if the log xml file logFilePath </span>
+<span class="sd"> has to be shown or not in the hat log.</span>
+<span class="sd"> </span>
+<span class="sd"> :param logFilePath str: the path to the command xml log file</span>
+<span class="sd"> :param cmd str: the command of the log file</span>
+<span class="sd"> :param application str: the application passed as parameter </span>
+<span class="sd"> to the salomeTools command</span>
+<span class="sd"> :param notShownCommands list: the list of commands </span>
+<span class="sd"> that are not shown by default</span>
+<span class="sd"> </span>
+<span class="sd"> :return: True if cmd is not in notShownCommands and the application </span>
+<span class="sd"> in the log file corresponds to application</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="c"># When the command is not in notShownCommands, no need to go further :</span>
+ <span class="c"># Do not show</span>
+ <span class="k">if</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">notShownCommands</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
+
+ <span class="c"># Get the application of the log file</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">logFileXml</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">ReadXmlFile</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"WARNING: the log file </span><span class="si">%s</span><span class="s"> cannot be read:"</span> <span class="o">%</span> <span class="n">logFilePath</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">e</span><span class="p">)))</span>
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
+
+ <span class="k">if</span> <span class="s">'application'</span> <span class="ow">in</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">appliLog</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'application'</span><span class="p">)</span>
+ <span class="n">launched_cmd</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'Site'</span><span class="p">)</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="s">'launchedCommand'</span><span class="p">]</span>
+ <span class="c"># if it corresponds, then the log has to be shown</span>
+ <span class="k">if</span> <span class="n">appliLog</span> <span class="o">==</span> <span class="n">application</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
+ <span class="k">elif</span> <span class="n">application</span> <span class="o">!=</span> <span class="s">'None'</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
+
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
+
+ <span class="k">if</span> <span class="n">application</span> <span class="o">==</span> <span class="s">'None'</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
+
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
+</div>
+<div class="viewcode-block" id="list_log_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.list_log_file">[docs]</a><span class="k">def</span> <span class="nf">list_log_file</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">expression</span><span class="p">):</span>
+ <span class="sd">"""Find all files corresponding to expression in dirPath</span>
+<span class="sd"> </span>
+<span class="sd"> :param dirPath str: the directory where to search the files</span>
+<span class="sd"> :param expression str: the regular expression of files to find</span>
+<span class="sd"> :return: the list of files path and informations about it</span>
+<span class="sd"> :rtype: list</span>
+<span class="sd"> """</span>
+ <span class="n">lRes</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">fileName</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dirPath</span><span class="p">):</span>
+ <span class="c"># YYYYMMDD_HHMMSS_namecmd.xml</span>
+ <span class="n">sExpr</span> <span class="o">=</span> <span class="n">expression</span>
+ <span class="n">oExpr</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">sExpr</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">oExpr</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">fileName</span><span class="p">):</span>
+ <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span>
+ <span class="k">if</span> <span class="n">fileName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"micro_"</span><span class="p">):</span>
+ <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s">"micro_"</span><span class="p">):]</span>
+ <span class="c"># get date and hour and format it</span>
+ <span class="n">date_hour_cmd_host</span> <span class="o">=</span> <span class="n">file_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'_'</span><span class="p">)</span>
+ <span class="n">date_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">date</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">date_not_formated</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">],</span>
+ <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">],</span>
+ <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">4</span><span class="p">])</span>
+ <span class="n">hour_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">hour</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">],</span>
+ <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">],</span>
+ <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">])</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">date_hour_cmd_host</span><span class="p">)</span> <span class="o"><</span> <span class="mi">4</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s">'.xml'</span><span class="p">)]</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">3</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s">'.xml'</span><span class="p">)]</span>
+ <span class="n">lRes</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">fileName</span><span class="p">),</span>
+ <span class="n">date_not_formated</span><span class="p">,</span>
+ <span class="n">date</span><span class="p">,</span>
+ <span class="n">hour_not_formated</span><span class="p">,</span>
+ <span class="n">hour</span><span class="p">,</span>
+ <span class="n">cmd</span><span class="p">,</span>
+ <span class="n">host</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">lRes</span>
+</div>
+<div class="viewcode-block" id="update_hat_xml"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.update_hat_xml">[docs]</a><span class="k">def</span> <span class="nf">update_hat_xml</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">application</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">notShownCommands</span> <span class="o">=</span> <span class="p">[]):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Create the xml file in logDir that contain all the xml file </span>
+<span class="sd"> and have a name like YYYYMMDD_HHMMSS_namecmd.xml</span>
+<span class="sd"> </span>
+<span class="sd"> :param logDir str: the directory to parse</span>
+<span class="sd"> :param application str: the name of the application if there is any</span>
+<span class="sd"> """</span>
+ <span class="c"># Create an instance of XmlLogFile class to create hat.xml file</span>
+ <span class="n">xmlHatFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="s">'hat.xml'</span><span class="p">)</span>
+ <span class="n">xmlHat</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">XmlLogFile</span><span class="p">(</span><span class="n">xmlHatFilePath</span><span class="p">,</span>
+ <span class="s">"LOGlist"</span><span class="p">,</span> <span class="p">{</span><span class="s">"application"</span> <span class="p">:</span> <span class="n">application</span><span class="p">})</span>
+ <span class="c"># parse the log directory to find all the command logs, </span>
+ <span class="c"># then add it to the xml file</span>
+ <span class="n">lLogFile</span> <span class="o">=</span> <span class="n">list_log_file</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">log_macro_command_file_expression</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">date</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">__</span> <span class="ow">in</span> <span class="n">lLogFile</span><span class="p">:</span>
+ <span class="n">showLog</span><span class="p">,</span> <span class="n">cmdAppli</span><span class="p">,</span> <span class="n">full_cmd</span> <span class="o">=</span> <span class="n">show_command_log</span><span class="p">(</span><span class="n">filePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span>
+ <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">)</span>
+ <span class="c">#if cmd not in notShownCommands:</span>
+ <span class="k">if</span> <span class="n">showLog</span><span class="p">:</span>
+ <span class="c"># add a node to the hat.xml file</span>
+ <span class="n">xmlHat</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s">"LogCommand"</span><span class="p">,</span>
+ <span class="n">text</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">filePath</span><span class="p">),</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s">"date"</span> <span class="p">:</span> <span class="n">date</span><span class="p">,</span>
+ <span class="s">"hour"</span> <span class="p">:</span> <span class="n">hour</span><span class="p">,</span>
+ <span class="s">"cmd"</span> <span class="p">:</span> <span class="n">cmd</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="n">cmdAppli</span><span class="p">,</span>
+ <span class="s">"full_command"</span> <span class="p">:</span> <span class="n">full_cmd</span><span class="p">})</span>
+
+ <span class="c"># Write the file on the hard drive</span>
+ <span class="n">xmlHat</span><span class="o">.</span><span class="n">write_tree</span><span class="p">(</span><span class="s">'hat.xsl'</span><span class="p">)</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.options — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.options</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+<span class="sd">'''The Options class that manages the access to all options passed as </span>
+<span class="sd"> parameters in salomeTools command lines</span>
+<span class="sd">'''</span>
+<span class="kn">import</span> <span class="nn">getopt</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">printcolors</span>
+
+<div class="viewcode-block" id="OptResult"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.OptResult">[docs]</a><span class="k">class</span> <span class="nc">OptResult</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">'''An instance of this class will be the object manipulated</span>
+<span class="sd"> in code of all salomeTools commands</span>
+<span class="sd"> The aim of this class is to have an elegant syntax </span>
+<span class="sd"> to manipulate the options. </span>
+<span class="sd"> ex: </span>
+<span class="sd"> print(options.level)</span>
+<span class="sd"> 5</span>
+<span class="sd"> '''</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''Initialization</span>
+<span class="sd"> '''</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="sd">'''Overwrite of the __getattr__ function </span>
+<span class="sd"> to customize it for option usage</span>
+<span class="sd"> </span>
+<span class="sd"> :param name str: The attribute to get the value.</span>
+<span class="sd"> :return: the value corresponding to the attribute.</span>
+<span class="sd"> :rtype: str,int,list,boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">name</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s">u" is not a valid option"</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">'''Overwrite of the __setattr__ function </span>
+<span class="sd"> to customize it for option usage</span>
+<span class="sd"> </span>
+<span class="sd"> :param name str: The attribute to set.</span>
+<span class="sd"> :param value str: The value corresponding to the attribute.</span>
+<span class="sd"> :return: Nothing.</span>
+<span class="sd"> :rtype: N\A</span>
+<span class="sd"> '''</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">,</span><span class="n">value</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Options"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options">[docs]</a><span class="k">class</span> <span class="nc">Options</span><span class="p">:</span>
+ <span class="sd">'''Class to manage all salomeTools options</span>
+<span class="sd"> '''</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''Initialization</span>
+<span class="sd"> '''</span>
+ <span class="c"># The options field stocks all options of a command </span>
+ <span class="c"># in a list that contains dicts</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="c"># The list of available option type</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">availableOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s">"boolean"</span><span class="p">,</span> <span class="s">"string"</span><span class="p">,</span> <span class="s">"int"</span><span class="p">,</span> <span class="s">"float"</span><span class="p">,</span>
+ <span class="s">"long"</span><span class="p">,</span> <span class="s">"list"</span><span class="p">,</span> <span class="s">"list2"</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">default</span> <span class="o">=</span> <span class="bp">None</span>
+
+<div class="viewcode-block" id="Options.add_option"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.add_option">[docs]</a> <span class="k">def</span> <span class="nf">add_option</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">shortName</span><span class="p">,</span> <span class="n">longName</span><span class="p">,</span>
+ <span class="n">optionType</span><span class="p">,</span> <span class="n">destName</span><span class="p">,</span> <span class="n">helpString</span><span class="o">=</span><span class="s">""</span><span class="p">,</span> <span class="n">default</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Method to add an option to a command. It gets all attributes</span>
+<span class="sd"> of an option and append it in the options field</span>
+<span class="sd"> </span>
+<span class="sd"> :param shortName str: The short name of the option</span>
+<span class="sd"> (ex "l" for level option).</span>
+<span class="sd"> :param longName str: The long name of the option </span>
+<span class="sd"> (ex "level" for level option).</span>
+<span class="sd"> :param optionType str: The type of the option (ex "int").</span>
+<span class="sd"> :param destName str: The name that will be used in the code.</span>
+<span class="sd"> :param helpString str: The text to display </span>
+<span class="sd"> when user ask for help on a command. </span>
+<span class="sd"> :return: Nothing.</span>
+<span class="sd"> :rtype: N\A</span>
+<span class="sd"> '''</span>
+ <span class="n">option</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'shortName'</span><span class="p">]</span> <span class="o">=</span> <span class="n">shortName</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'longName'</span><span class="p">]</span> <span class="o">=</span> <span class="n">longName</span>
+
+ <span class="k">if</span> <span class="n">optionType</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">availableOptions</span><span class="p">:</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">"error optionType"</span><span class="p">,</span> <span class="n">optionType</span><span class="p">,</span> <span class="s">"not available."</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
+
+ <span class="n">option</span><span class="p">[</span><span class="s">'optionType'</span><span class="p">]</span> <span class="o">=</span> <span class="n">optionType</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'destName'</span><span class="p">]</span> <span class="o">=</span> <span class="n">destName</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'helpString'</span><span class="p">]</span> <span class="o">=</span> <span class="n">helpString</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="n">default</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Options.print_help"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.print_help">[docs]</a> <span class="k">def</span> <span class="nf">print_help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''Method that display all options stored in self.options and there help</span>
+<span class="sd"> </span>
+<span class="sd"> :return: Nothing.</span>
+<span class="sd"> :rtype: N\A</span>
+<span class="sd"> '''</span>
+ <span class="c"># Do nothing if there are no options</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span>
+
+ <span class="c"># for all options, print its values. </span>
+ <span class="c"># "shortname" is an optional field of the options </span>
+ <span class="k">print</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Available options are:"</span><span class="p">)))</span>
+ <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s">'shortName'</span> <span class="ow">in</span> <span class="n">option</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">option</span><span class="p">[</span><span class="s">'shortName'</span><span class="p">])</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">" -</span><span class="si">%(shortName)1s</span><span class="s">, --</span><span class="si">%(longName)s</span><span class="s">"</span>
+ <span class="s">" (</span><span class="si">%(optionType)s</span><span class="s">)</span><span class="se">\n\t</span><span class="si">%(helpString)s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">option</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">" --</span><span class="si">%(longName)s</span><span class="s"> (</span><span class="si">%(optionType)s</span><span class="s">)</span><span class="se">\n\t</span><span class="si">%(helpString)s</span><span class="se">\n</span><span class="s">"</span>
+ <span class="o">%</span> <span class="n">option</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Options.parse_args"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.parse_args">[docs]</a> <span class="k">def</span> <span class="nf">parse_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">argList</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Method that instantiates the class OptResult </span>
+<span class="sd"> that gives access to all options in the code</span>
+<span class="sd"> </span>
+<span class="sd"> :param argList list: the raw list of arguments that were passed</span>
+<span class="sd"> :return: optResult, args : optResult is the option instance </span>
+<span class="sd"> to manipulate in the code. args </span>
+<span class="sd"> is the full raw list of passed options </span>
+<span class="sd"> :rtype: (class 'common.options.OptResult',list)</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="n">argList</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">argList</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
+
+ <span class="c"># format shortNameOption and longNameOption </span>
+ <span class="c"># to make right arguments to getopt.getopt function</span>
+ <span class="n">shortNameOption</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="n">longNameOption</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">:</span>
+ <span class="n">shortNameOption</span> <span class="o">=</span> <span class="n">shortNameOption</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="s">'shortName'</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s">'shortName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s">""</span> <span class="ow">and</span> <span class="n">option</span><span class="p">[</span><span class="s">'optionType'</span><span class="p">]</span> <span class="o">!=</span> <span class="s">"boolean"</span><span class="p">:</span>
+ <span class="n">shortNameOption</span> <span class="o">=</span> <span class="n">shortNameOption</span> <span class="o">+</span> <span class="s">":"</span>
+
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s">'longName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s">""</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s">'optionType'</span><span class="p">]</span> <span class="o">!=</span> <span class="s">"boolean"</span><span class="p">:</span>
+ <span class="n">longNameOption</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">option</span><span class="p">[</span><span class="s">'longName'</span><span class="p">]</span> <span class="o">+</span> <span class="s">"="</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">longNameOption</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">option</span><span class="p">[</span><span class="s">'longName'</span><span class="p">])</span>
+
+ <span class="c"># call to getopt.getopt function to get the option </span>
+ <span class="c"># passed in the command regarding the available options</span>
+ <span class="n">optlist</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">argList</span><span class="p">,</span> <span class="n">shortNameOption</span><span class="p">,</span> <span class="n">longNameOption</span><span class="p">)</span>
+
+ <span class="c"># instantiate and completing the optResult that will be returned</span>
+ <span class="n">optResult</span> <span class="o">=</span> <span class="n">OptResult</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">:</span>
+ <span class="n">shortOption</span> <span class="o">=</span> <span class="s">"-"</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="s">'shortName'</span><span class="p">]</span>
+ <span class="n">longOption</span> <span class="o">=</span> <span class="s">"--"</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="s">'longName'</span><span class="p">]</span>
+ <span class="n">optionType</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="s">'optionType'</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">optlist</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">opt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="n">shortOption</span><span class="p">,</span> <span class="n">longOption</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"string"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"boolean"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"int"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"float"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"long"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">long</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"list"</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s">"list2"</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">","</span><span class="p">)</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">elts</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span> <span class="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">))</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">elts</span><span class="p">)</span>
+
+ <span class="n">optResult</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="n">option</span><span class="p">[</span><span class="s">'destName'</span><span class="p">],</span> <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">])</span>
+ <span class="c"># free the option in order to be able to make </span>
+ <span class="c"># a new free call of options (API case)</span>
+ <span class="n">option</span><span class="p">[</span><span class="s">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">return</span> <span class="n">optResult</span><span class="p">,</span> <span class="n">args</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.printcolors — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.printcolors</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+<span class="sd">'''In this file is stored the mechanism that manage color prints in the terminal</span>
+<span class="sd">'''</span>
+
+<span class="c"># define constant to use in scripts</span>
+<span class="n">COLOR_ERROR</span> <span class="o">=</span> <span class="s">'ERROR'</span>
+<span class="n">COLOR_WARNING</span> <span class="o">=</span> <span class="s">'WARNING'</span>
+<span class="n">COLOR_SUCCESS</span> <span class="o">=</span> <span class="s">'SUCCESS'</span>
+<span class="n">COLOR_LABEL</span> <span class="o">=</span> <span class="s">'LABEL'</span>
+<span class="n">COLOR_HEADER</span> <span class="o">=</span> <span class="s">'HEADER'</span>
+<span class="n">COLOR_INFO</span> <span class="o">=</span> <span class="s">'INFO'</span>
+<span class="n">COLOR_HIGLIGHT</span> <span class="o">=</span> <span class="s">'HIGHLIGHT'</span>
+
+<span class="c"># the color map to use to print the colors</span>
+<span class="n">__colormap__</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="n">COLOR_ERROR</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[1m</span><span class="se">\033</span><span class="s">[31m'</span><span class="p">,</span>
+ <span class="n">COLOR_SUCCESS</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[1m</span><span class="se">\033</span><span class="s">[32m'</span><span class="p">,</span>
+ <span class="n">COLOR_WARNING</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[33m'</span><span class="p">,</span>
+ <span class="n">COLOR_HEADER</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[34m'</span><span class="p">,</span>
+ <span class="n">COLOR_INFO</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[35m'</span><span class="p">,</span>
+ <span class="n">COLOR_LABEL</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[36m'</span><span class="p">,</span>
+ <span class="n">COLOR_HIGLIGHT</span><span class="p">:</span> <span class="s">'</span><span class="se">\033</span><span class="s">[97m</span><span class="se">\033</span><span class="s">[43m'</span>
+<span class="p">}</span>
+
+<span class="c"># list of available codes</span>
+<span class="n">__code_range__</span> <span class="o">=</span> <span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">]</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="mi">38</span><span class="p">))</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">40</span><span class="p">,</span> <span class="mi">48</span><span class="p">))</span>
+ <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">90</span><span class="p">,</span> <span class="mi">98</span><span class="p">))</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="mi">108</span><span class="p">)))</span>
+
+<div class="viewcode-block" id="printc"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printc">[docs]</a><span class="k">def</span> <span class="nf">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">code</span><span class="o">=</span><span class="s">''</span><span class="p">):</span>
+ <span class="sd">'''print a text with colors</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :param code str: The color to use.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="c"># no code means 'auto mode' (works only for OK, KO, NO and ERR*)</span>
+ <span class="k">if</span> <span class="n">code</span> <span class="o">==</span> <span class="s">''</span><span class="p">:</span>
+ <span class="n">striptxt</span> <span class="o">=</span> <span class="n">txt</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">striptxt</span> <span class="o">==</span> <span class="s">"OK"</span><span class="p">:</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="n">COLOR_SUCCESS</span>
+ <span class="k">elif</span> <span class="n">striptxt</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"KO"</span><span class="p">,</span> <span class="s">"NO"</span><span class="p">]</span> <span class="ow">or</span> <span class="n">striptxt</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"ERR"</span><span class="p">):</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="n">COLOR_ERROR</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">txt</span>
+
+ <span class="c"># no code => output the originial text</span>
+ <span class="k">if</span> <span class="n">code</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">__colormap__</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">or</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">code</span><span class="p">]</span> <span class="o">==</span> <span class="s">''</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">txt</span>
+
+ <span class="k">return</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">code</span><span class="p">]</span> <span class="o">+</span> <span class="n">txt</span> <span class="o">+</span> <span class="s">'</span><span class="se">\033</span><span class="s">[0m'</span>
+</div>
+<div class="viewcode-block" id="printcInfo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcInfo">[docs]</a><span class="k">def</span> <span class="nf">printcInfo</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text info color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_INFO</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcError"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcError">[docs]</a><span class="k">def</span> <span class="nf">printcError</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text error color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_ERROR</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcWarning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcWarning">[docs]</a><span class="k">def</span> <span class="nf">printcWarning</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text warning color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_WARNING</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcHeader"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcHeader">[docs]</a><span class="k">def</span> <span class="nf">printcHeader</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text header color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_HEADER</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcLabel"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcLabel">[docs]</a><span class="k">def</span> <span class="nf">printcLabel</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text label color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_LABEL</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcSuccess"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcSuccess">[docs]</a><span class="k">def</span> <span class="nf">printcSuccess</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text success color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_SUCCESS</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="printcHighlight"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcHighlight">[docs]</a><span class="k">def</span> <span class="nf">printcHighlight</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
+ <span class="sd">'''print a text highlight color</span>
+<span class="sd"> </span>
+<span class="sd"> :param txt str: The text to be printed.</span>
+<span class="sd"> :return: The colored text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_HIGLIGHT</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="cleancolor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.cleancolor">[docs]</a><span class="k">def</span> <span class="nf">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
+ <span class="sd">'''remove color from a colored text.</span>
+<span class="sd"> </span>
+<span class="sd"> :param message str: The text to be cleaned.</span>
+<span class="sd"> :return: The cleaned text.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="n">message</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">message</span>
+
+ <span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">'</span><span class="se">\033</span><span class="s">[0m'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">__code_range__</span><span class="p">:</span>
+ <span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">'</span><span class="se">\033</span><span class="s">[</span><span class="si">%d</span><span class="s">m'</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">message</span>
+</div>
+<div class="viewcode-block" id="print_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_value">[docs]</a><span class="k">def</span> <span class="nf">print_value</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s">""</span><span class="p">):</span>
+ <span class="sd">'''shortcut method to print a label and a value with the info color</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger class logger: the logger instance.</span>
+<span class="sd"> :param label int: the label to print.</span>
+<span class="sd"> :param value str: the value to print.</span>
+<span class="sd"> :param level int: the level of verboseness.</span>
+<span class="sd"> :param suffix str: the suffix to add at the end.</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="n">logger</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)),</span> <span class="n">suffix</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)),</span>
+ <span class="n">suffix</span><span class="p">),</span> <span class="n">level</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="print_color_range"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_color_range">[docs]</a><span class="k">def</span> <span class="nf">print_color_range</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
+ <span class="sd">'''print possible range values for colors</span>
+<span class="sd"> </span>
+<span class="sd"> :param start int: The smaller value.</span>
+<span class="sd"> :param end int: The bigger value.</span>
+<span class="sd"> '''</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">"</span><span class="se">\033</span><span class="s">[</span><span class="si">%d</span><span class="s">m</span><span class="si">%3d</span><span class="se">\033</span><span class="s">[0m"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">k</span><span class="p">),)</span>
+ <span class="k">print</span>
+
+<span class="c"># This method prints the color map</span></div>
+<div class="viewcode-block" id="print_color_map"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_color_map">[docs]</a><span class="k">def</span> <span class="nf">print_color_map</span><span class="p">():</span>
+ <span class="sd">'''This method prints the color map</span>
+<span class="sd"> '''</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">"colormap:"</span><span class="p">)</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">"{"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">__colormap__</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
+ <span class="n">codes</span> <span class="o">=</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'</span><span class="se">\033</span><span class="s">['</span><span class="p">)</span>
+ <span class="n">codes</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span> <span class="n">codes</span><span class="p">)</span>
+ <span class="n">codes</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">codes</span><span class="p">)</span>
+ <span class="k">print</span><span class="p">(</span><span class="n">printc</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s">: '</span><span class="si">%s</span><span class="s">', "</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="s">';'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">codes</span><span class="p">)),</span> <span class="n">k</span><span class="p">))</span>
+ <span class="k">print</span><span class="p">(</span><span class="s">"}"</span><span class="p">)</span>
+</pre></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.product — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.product</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2012 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="sd">"""\</span>
+<span class="sd">In this file are implemented the methods </span>
+<span class="sd">relative to the product notion of salomeTools</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">re</span>
+
+<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">import</span> <span class="nn">src.debug</span> <span class="kn">as</span> <span class="nn">DBG</span>
+
+<span class="n">AVAILABLE_VCS</span> <span class="o">=</span> <span class="p">[</span><span class="s">'git'</span><span class="p">,</span> <span class="s">'svn'</span><span class="p">,</span> <span class="s">'cvs'</span><span class="p">]</span>
+<span class="n">config_expression</span> <span class="o">=</span> <span class="s">"^config-\d+$"</span>
+<span class="n">VERSION_DELIMITER</span> <span class="o">=</span> <span class="s">"_to_"</span>
+
+<div class="viewcode-block" id="get_product_config"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_config">[docs]</a><span class="k">def</span> <span class="nf">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">with_install_dir</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""Get the specific configuration of a product from the global configuration</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param product_name str: The name of the product</span>
+<span class="sd"> :param with_install_dir boolean: If false, do not provide an install </span>
+<span class="sd"> directory (at false only for internal use </span>
+<span class="sd"> of the function check_config_exists)</span>
+<span class="sd"> :return: the specific configuration of the product</span>
+<span class="sd"> :rtype: Config</span>
+<span class="sd"> """</span>
+
+ <span class="c"># Get the version of the product from the application definition</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span>
+ <span class="c"># if no version, then take the default one defined in the application</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">tag</span>
+
+ <span class="c"># Define debug and dev modes</span>
+ <span class="c"># Get the tag if a dictionary is given in APPLICATION.products for the</span>
+ <span class="c"># current product </span>
+ <span class="n">debug</span> <span class="o">=</span> <span class="s">'no'</span>
+ <span class="n">dev</span> <span class="o">=</span> <span class="s">'no'</span>
+ <span class="n">base</span> <span class="o">=</span> <span class="s">'maybe'</span>
+ <span class="n">section</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">):</span>
+ <span class="n">dic_version</span> <span class="o">=</span> <span class="n">version</span>
+ <span class="c"># Get the version/tag</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">'tag'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">tag</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">tag</span>
+
+ <span class="c"># Get the debug if any</span>
+ <span class="k">if</span> <span class="s">'debug'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">debug</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">debug</span>
+
+ <span class="c"># Get the dev if any</span>
+ <span class="k">if</span> <span class="s">'dev'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">dev</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">dev</span>
+
+ <span class="c"># Get the base if any</span>
+ <span class="k">if</span> <span class="s">'base'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">base</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">base</span>
+
+ <span class="c"># Get the section if any</span>
+ <span class="k">if</span> <span class="s">'section'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">section</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">section</span>
+
+ <span class="n">vv</span> <span class="o">=</span> <span class="n">version</span>
+ <span class="c"># substitute some character with _ in order to get the correct definition</span>
+ <span class="c"># in config.PRODUCTS. This is done because the pyconf tool does not handle</span>
+ <span class="c"># the . and - characters </span>
+ <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="s">".-"</span><span class="p">:</span> <span class="n">vv</span> <span class="o">=</span> <span class="n">vv</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="s">"_"</span><span class="p">)</span>
+
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">product_name</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">:</span>
+ <span class="c"># Search for the product description in the configuration</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_section</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">vv</span><span class="p">,</span> <span class="n">section</span><span class="p">)</span>
+
+ <span class="c"># merge opt_depend in depend</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="s">'opt_depend'</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">depend</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">opt_depend</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">depend</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">depend</span><span class="p">,</span><span class="s">''</span><span class="p">)</span>
+
+ <span class="c"># In case of a product get with a vcs, </span>
+ <span class="c"># put the tag (equal to the version)</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="ow">in</span> <span class="n">AVAILABLE_VCS</span><span class="p">:</span>
+
+ <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s">'git'</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">git_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
+
+ <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s">'svn'</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">svn_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
+
+ <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s">'cvs'</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
+
+ <span class="c"># In case of a fixed product, </span>
+ <span class="c"># define the install_dir (equal to the version)</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">version</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s">"fixed"</span>
+
+ <span class="c"># Check if the product is defined as native in the application</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="s">"native"</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s">"native"</span>
+ <span class="k">elif</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s">"native"</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"The product </span><span class="si">%(prod)s</span><span class="s"> has version </span><span class="si">%(ver)s</span><span class="s"> but is "</span>
+ <span class="s">"declared as native in its definition"</span> <span class="o">%</span>
+ <span class="p">{</span> <span class="s">'prod'</span><span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s">'ver'</span><span class="p">:</span> <span class="n">version</span><span class="p">})</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="c"># If there is no definition but the product is declared as native,</span>
+ <span class="c"># construct a new definition containing only the get_source key</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">version</span> <span class="o">==</span> <span class="s">"native"</span><span class="p">:</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s">"native"</span>
+
+ <span class="c"># If there is no definition but the product is fixed,</span>
+ <span class="c"># construct a new definition containing only the product name</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s">"fixed"</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s">"environ"</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span> <span class="s">""</span><span class="p">)</span>
+
+
+ <span class="c"># If prod_info is still None, it means that there is no product definition</span>
+ <span class="c"># in the config. The user has to provide it.</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">prod_pyconf_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">product_name</span> <span class="o">+</span> <span class="s">".pyconf"</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">prod_pyconf_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">No definition found for the product </span><span class="si">%(1)s</span><span class="s">.</span>
+<span class="s">Please create a </span><span class="si">%(2)s</span><span class="s">.pyconf file somewhere in:</span>
+<span class="si">%(3)s</span><span class="s">"""</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">"1"</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
+ <span class="s">"2"</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
+ <span class="s">"3"</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span> <span class="p">}</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">No definition corresponding to the version </span><span class="si">%(1)s</span><span class="s"> was found in the file:</span>
+<span class="s"> </span><span class="si">%(2)s</span><span class="s">.</span>
+<span class="s">Please add a section in it."""</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span><span class="s">"1"</span> <span class="p">:</span> <span class="n">vv</span><span class="p">,</span> <span class="s">"2"</span> <span class="p">:</span> <span class="n">prod_pyconf_path</span><span class="p">}</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="c"># Set the debug, dev and version keys</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">debug</span> <span class="o">=</span> <span class="n">debug</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">dev</span> <span class="o">=</span> <span class="n">dev</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">version</span>
+
+ <span class="c"># Set the archive_info if the product is get in archive mode</span>
+ <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s">"archive"</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s">"archive_info"</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s">"archive_info"</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span>
+ <span class="s">""</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s">"archive_name"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="p">:</span>
+ <span class="n">arch_name</span> <span class="o">=</span> <span class="n">product_name</span> <span class="o">+</span> <span class="s">"-"</span> <span class="o">+</span> <span class="n">version</span> <span class="o">+</span> <span class="s">".tar.gz"</span>
+ <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">arch_name</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Archive </span><span class="si">%(1)s</span><span class="s"> for </span><span class="si">%(2)s</span><span class="s"> not found in config.PATHS.ARCHIVEPATH"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s">"1"</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_name</span> <span class="c">#without path</span>
+ <span class="c"># raise src.SatException(msg) #may be a warning, continue #8646</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">)</span> <span class="o">==</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">):</span>
+ <span class="n">arch_name</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span>
+ <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
+ <span class="n">arch_name</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Archive </span><span class="si">%(1)s</span><span class="s"> for </span><span class="si">%(2)s</span><span class="s"> not found in config.PATHS.ARCHIVEPATH"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s">"1"</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span> <span class="c">#avoid 2 messages in compile</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_name</span> <span class="c">#without path</span>
+ <span class="c"># raise src.SatException(msg) #may be a warning, continue #8646</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
+
+ <span class="c"># If the product compiles with a script, check the script existence</span>
+ <span class="c"># and if it is executable</span>
+ <span class="k">if</span> <span class="n">product_has_script</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
+ <span class="c"># Check the compil_script key existence</span>
+ <span class="k">if</span> <span class="s">"compil_script"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"""</span><span class="se">\</span>
+<span class="s">No compilation script found for the product </span><span class="si">%s</span><span class="s">.</span>
+<span class="s">Please provide a 'compil_script' key in its definition."""</span><span class="p">)</span> <span class="o">%</span> <span class="n">product_name</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="c"># Get the path of the script</span>
+ <span class="n">script</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span>
+ <span class="n">script_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">script</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">script</span> <span class="o">==</span> <span class="n">script_name</span><span class="p">:</span>
+ <span class="c"># Only a name is given. Search in the default directory</span>
+ <span class="n">script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">script_name</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
+ <span class="s">"compil_scripts"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">script_path</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s">"Compilation script not found: </span><span class="si">%s</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span> <span class="o">=</span> <span class="n">script_path</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s">".sh"</span><span class="p">)]</span> <span class="o">+</span> <span class="s">".bat"</span>
+
+ <span class="c"># Check that the script is executable</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">):</span>
+ <span class="c">#raise src.SatException(</span>
+ <span class="c"># _("Compilation script cannot be executed: %s") % </span>
+ <span class="c"># prod_info.compil_script)</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s">"Compilation script cannot be executed:"</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">)</span>
+
+ <span class="c"># Get the full paths of all the patches</span>
+ <span class="k">if</span> <span class="n">product_has_patches</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
+ <span class="n">patches</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span><span class="p">:</span>
+ <span class="n">patch_path</span> <span class="o">=</span> <span class="n">patch</span>
+ <span class="c"># If only a filename, then search for the patch in the PRODUCTPATH</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">patch_path</span><span class="p">:</span>
+ <span class="c"># Search in the PRODUCTPATH/patches</span>
+ <span class="n">patch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
+ <span class="s">"patches"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">patch_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Patch </span><span class="si">%(patch_name)s</span><span class="s"> for </span><span class="si">%(prod_name)s</span><span class="s"> not found:"</span>
+ <span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">{</span><span class="s">"patch_name"</span> <span class="p">:</span> <span class="n">patch</span><span class="p">,</span>
+ <span class="s">"prod_name"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="n">patches</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s">"problem in prod_info.patches"</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span> <span class="o">=</span> <span class="n">patches</span>
+
+ <span class="c"># Get the full paths of the environment scripts</span>
+ <span class="k">if</span> <span class="n">product_has_env_script</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
+ <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span>
+ <span class="c"># If only a filename, then search for the environment script </span>
+ <span class="c"># in the PRODUCTPATH/env_scripts</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">env_script_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">env_script_path</span><span class="p">:</span>
+ <span class="c"># Search in the PRODUCTPATH/env_scripts</span>
+ <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
+ <span class="s">"env_scripts"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">env_script_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Environment script </span><span class="si">%(env_name)s</span><span class="s"> for </span><span class="si">%(prod_name)s</span><span class="s"> not "</span>
+ <span class="s">"found.</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">{</span><span class="s">"env_name"</span> <span class="p">:</span> <span class="n">env_script_path</span><span class="p">,</span>
+ <span class="s">"prod_name"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span> <span class="o">=</span> <span class="n">env_script_path</span>
+
+ <span class="k">if</span> <span class="n">with_install_dir</span><span class="p">:</span>
+ <span class="c"># The variable with_install_dir is at false only for internal use </span>
+ <span class="c"># of the function get_install_dir</span>
+
+ <span class="c"># Save the install_dir key if there is any</span>
+ <span class="k">if</span> <span class="s">"install_dir"</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">and</span> <span class="ow">not</span> <span class="s">"install_dir_save"</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir_save</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span>
+
+ <span class="c"># if it is not the first time the install_dir is computed, it means</span>
+ <span class="c"># that install_dir_save exists and it has to be taken into account.</span>
+ <span class="k">if</span> <span class="s">"install_dir_save"</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir_save</span>
+
+ <span class="c"># Set the install_dir key</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">get_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">prod_info</span>
+</div>
+<div class="viewcode-block" id="get_product_section"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_section">[docs]</a><span class="k">def</span> <span class="nf">get_product_section</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""Get the product description from the configuration</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param product_name str: The product name</span>
+<span class="sd"> :param version str: The version of the product</span>
+<span class="sd"> :param section str: The searched section (if not None, the section is </span>
+<span class="sd"> explicitly given</span>
+<span class="sd"> :return: The product description</span>
+<span class="sd"> :rtype: Config</span>
+<span class="sd"> """</span>
+
+ <span class="c"># if section is not None, try to get the corresponding section</span>
+ <span class="k">if</span> <span class="n">section</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">section</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
+ <span class="k">return</span> <span class="bp">None</span>
+ <span class="c"># returns specific information for the given version</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="n">section</span><span class="p">]</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="n">section</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
+ <span class="k">return</span> <span class="n">prod_info</span>
+
+ <span class="c"># If it exists, get the information of the product_version</span>
+ <span class="k">if</span> <span class="s">"version_"</span> <span class="o">+</span> <span class="n">version</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
+ <span class="c"># returns specific information for the given version</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="s">"version_"</span> <span class="o">+</span> <span class="n">version</span><span class="p">]</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="s">"version_"</span> <span class="o">+</span> <span class="n">version</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
+ <span class="k">return</span> <span class="n">prod_info</span>
+
+ <span class="c"># Else, check if there is a description for multiple versions</span>
+ <span class="n">l_section_name</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+ <span class="n">l_section_ranges</span> <span class="o">=</span> <span class="p">[</span><span class="n">section_name</span> <span class="k">for</span> <span class="n">section_name</span> <span class="ow">in</span> <span class="n">l_section_name</span>
+ <span class="k">if</span> <span class="n">VERSION_DELIMITER</span> <span class="ow">in</span> <span class="n">section_name</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">section_range</span> <span class="ow">in</span> <span class="n">l_section_ranges</span><span class="p">:</span>
+ <span class="n">minimum</span><span class="p">,</span> <span class="n">maximum</span> <span class="o">=</span> <span class="n">section_range</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">VERSION_DELIMITER</span><span class="p">)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">version</span><span class="p">)</span> <span class="o">>=</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">minimum</span><span class="p">)</span>
+ <span class="ow">and</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">version</span><span class="p">)</span> <span class="o"><=</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">maximum</span><span class="p">)):</span>
+ <span class="c"># returns specific information for the versions</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="n">section_range</span><span class="p">]</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="n">section_range</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
+ <span class="k">return</span> <span class="n">prod_info</span>
+
+ <span class="c"># Else, get the standard informations</span>
+ <span class="k">if</span> <span class="s">"default"</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
+ <span class="c"># returns the generic information (given version not found)</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">default</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="s">"default"</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
+ <span class="k">return</span> <span class="n">prod_info</span>
+
+ <span class="c"># if noting was found, return None</span>
+ <span class="k">return</span> <span class="bp">None</span>
+ </div>
+<div class="viewcode-block" id="get_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
+ <span class="sd">"""Compute the installation directory of a given product </span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param base str: This corresponds to the value given by user in its </span>
+<span class="sd"> application.pyconf for the specific product. If "yes", the</span>
+<span class="sd"> user wants the product to be in base. If "no", he wants the</span>
+<span class="sd"> product to be in the application workdir</span>
+<span class="sd"> :param version str: The version of the product</span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> </span>
+<span class="sd"> :return: The path of the product installation</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="n">in_base</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="p">((</span><span class="s">"install_dir"</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">and</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">==</span> <span class="s">"base"</span><span class="p">)</span>
+ <span class="ow">or</span> <span class="n">base</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">):</span>
+ <span class="n">in_base</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">base</span> <span class="o">==</span> <span class="s">"no"</span> <span class="ow">or</span> <span class="p">(</span><span class="s">"no_base"</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span>
+ <span class="ow">and</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">no_base</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)):</span>
+ <span class="n">in_base</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="k">if</span> <span class="n">in_base</span><span class="p">:</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="n">get_base_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">,</span> <span class="n">version</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s">"install_dir"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">or</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">==</span> <span class="s">"base"</span><span class="p">:</span>
+ <span class="c"># Set it to the default value (in application directory)</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="s">"INSTALL"</span><span class="p">,</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span>
+
+ <span class="k">return</span> <span class="n">install_dir</span>
+</div>
+<div class="viewcode-block" id="get_base_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_base_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_base_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
+ <span class="sd">"""Compute the installation directory of a product in base </span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :param version str: The version of the product </span>
+<span class="sd"> :return: The path of the product installation</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> """</span>
+ <span class="n">base_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">prod_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base_path</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">"-"</span> <span class="o">+</span> <span class="n">version</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="s">"config-1"</span><span class="p">)</span>
+
+ <span class="n">exists</span><span class="p">,</span> <span class="n">install_dir</span> <span class="o">=</span> <span class="n">check_config_exists</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dir</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">exists</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">install_dir</span>
+
+ <span class="c"># Find the first config-<i> directory that is available in the product</span>
+ <span class="c"># directory</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">label</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">while</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="s">"config-</span><span class="si">%i</span><span class="s">"</span> <span class="o">%</span> <span class="n">label</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">install_dir</span><span class="p">):</span>
+ <span class="n">label</span><span class="o">+=</span><span class="mi">1</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">True</span>
+
+ <span class="k">return</span> <span class="n">install_dir</span>
+</div>
+<div class="viewcode-block" id="check_config_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_config_exists">[docs]</a><span class="k">def</span> <span class="nf">check_config_exists</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dir</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Verify that the installation directory of a product in a base exists</span>
+<span class="sd"> Check all the config-<i> directory and verify the sat-config.pyconf file</span>
+<span class="sd"> that is in it </span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param prod_dir str: The product installation directory path </span>
+<span class="sd"> (without config-<i>)</span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True or false is the installation is found or not </span>
+<span class="sd"> and if it is found, the path of the found installation</span>
+<span class="sd"> :rtype: (boolean, str)</span>
+<span class="sd"> """</span>
+ <span class="c"># check if the directories or files of the directory corresponds to the </span>
+ <span class="c"># directory installation of the product</span>
+ <span class="n">l_dir_and_files</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">dir_or_file</span> <span class="ow">in</span> <span class="n">l_dir_and_files</span><span class="p">:</span>
+ <span class="n">oExpr</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">config_expression</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span><span class="p">(</span><span class="n">oExpr</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">dir_or_file</span><span class="p">)):</span>
+ <span class="c"># not config-<i>, not interesting</span>
+ <span class="k">continue</span>
+ <span class="c"># check if there is the file sat-config.pyconf file in the installation</span>
+ <span class="c"># directory </span>
+ <span class="n">config_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">CONFIG_FILENAME</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">config_file</span><span class="p">):</span>
+ <span class="k">continue</span>
+
+ <span class="c"># If there is no dependency, it is the right path</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">:</span>
+ <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">compile_cfg</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">)</span>
+ <span class="k">continue</span>
+
+ <span class="c"># check if there is the config described in the file corresponds the </span>
+ <span class="c"># dependencies of the product</span>
+ <span class="n">config_corresponds</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">prod_dep</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
+ <span class="c"># if the dependency is not in the config, </span>
+ <span class="c"># the config does not correspond</span>
+ <span class="k">if</span> <span class="n">prod_dep</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">compile_cfg</span><span class="p">:</span>
+ <span class="n">config_corresponds</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">prod_dep_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dep</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="c"># If the version of the dependency does not correspond, </span>
+ <span class="c"># the config does not correspond</span>
+ <span class="k">if</span> <span class="n">prod_dep_info</span><span class="o">.</span><span class="n">version</span> <span class="o">!=</span> <span class="n">compile_cfg</span><span class="p">[</span><span class="n">prod_dep</span><span class="p">]:</span>
+ <span class="n">config_corresponds</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">break</span>
+
+ <span class="k">for</span> <span class="n">prod_name</span> <span class="ow">in</span> <span class="n">compile_cfg</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">prod_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
+ <span class="n">config_corresponds</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">break</span>
+
+ <span class="k">if</span> <span class="n">config_corresponds</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span>
+
+
+ </div>
+<div class="viewcode-block" id="get_products_infos"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_products_infos">[docs]</a><span class="k">def</span> <span class="nf">get_products_infos</span><span class="p">(</span><span class="n">lproducts</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
+ <span class="sd">"""Get the specific configuration of a list of products</span>
+<span class="sd"> </span>
+<span class="sd"> :param lproducts List: The list of product names</span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :return: the list of tuples </span>
+<span class="sd"> (product name, specific configuration of the product)</span>
+<span class="sd"> :rtype: [(str, Config)]</span>
+<span class="sd"> """</span>
+ <span class="n">products_infos</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="c"># Loop on product names</span>
+ <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">lproducts</span><span class="p">:</span>
+ <span class="c"># Get the specific configuration of the product</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">products_infos</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">prod</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"The </span><span class="si">%s</span><span class="s"> product has no definition "</span>
+ <span class="s">"in the configuration."</span><span class="p">)</span> <span class="o">%</span> <span class="n">prod</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">products_infos</span>
+</div>
+<div class="viewcode-block" id="get_product_dependencies"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_dependencies">[docs]</a><span class="k">def</span> <span class="nf">get_product_dependencies</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get recursively the list of products that are </span>
+<span class="sd"> in the product_info dependencies</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: the list of products in dependence</span>
+<span class="sd"> :rtype: list</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">"depend"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">or</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span> <span class="o">==</span> <span class="p">[]:</span>
+ <span class="k">return</span> <span class="p">[]</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">prod</span> <span class="o">==</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">prod</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">prod</span><span class="p">)</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod</span><span class="p">)</span>
+ <span class="n">dep_prod</span> <span class="o">=</span> <span class="n">get_product_dependencies</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">prod_in_dep</span> <span class="ow">in</span> <span class="n">dep_prod</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">prod_in_dep</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
+ <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">prod_in_dep</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="check_installation"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_installation">[docs]</a><span class="k">def</span> <span class="nf">check_installation</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Verify if a product is well installed. Checks install directory presence</span>
+<span class="sd"> and some additional files if it is defined in the config </span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if it is well installed</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="n">install_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">install_dir</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">"present_files"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"install"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">file_relative_path</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="o">.</span><span class="n">install</span><span class="p">:</span>
+ <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">install_dir</span><span class="p">,</span> <span class="n">file_relative_path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">file_path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="k">return</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="check_source"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_source">[docs]</a><span class="k">def</span> <span class="nf">check_source</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Verify if a sources of product is preset. Checks source directory presence</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if it is well installed</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"check_source product_info"</span><span class="p">,</span> <span class="n">product_info</span><span class="p">)</span>
+ <span class="n">source_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">source_dir</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">"present_files"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"source"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">file_relative_path</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="o">.</span><span class="n">source</span><span class="p">:</span>
+ <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">source_dir</span><span class="p">,</span> <span class="n">file_relative_path</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">file_path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="k">return</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="product_is_sample"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_sample">[docs]</a><span class="k">def</span> <span class="nf">product_is_sample</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has the sample type</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product has the sample type, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">'type'</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
+ <span class="n">ptype</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">type</span>
+ <span class="k">return</span> <span class="n">ptype</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'sample'</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="product_is_salome"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_salome">[docs]</a><span class="k">def</span> <span class="nf">product_is_salome</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is a SALOME module</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is a SALOME module, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"is_SALOME_module"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_SALOME_module</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="product_is_fixed"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_fixed">[docs]</a><span class="k">def</span> <span class="nf">product_is_fixed</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is fixed</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is fixed, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
+ <span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'fixed'</span>
+</div>
+<div class="viewcode-block" id="product_is_native"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_native">[docs]</a><span class="k">def</span> <span class="nf">product_is_native</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is native</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is native, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
+ <span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'native'</span>
+</div>
+<div class="viewcode-block" id="product_is_dev"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_dev">[docs]</a><span class="k">def</span> <span class="nf">product_is_dev</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is in dev mode</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is in dev mode, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">dev</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">dev</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="n">dev</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'yes'</span><span class="p">)</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'product_is_dev </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
+ <span class="c"># if product_info.name == "XDATA": return True #test #10569</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="product_is_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_debug">[docs]</a><span class="k">def</span> <span class="nf">product_is_debug</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is in debug mode</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is in debug mode, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">debug</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">debug</span>
+ <span class="k">return</span> <span class="n">debug</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'yes'</span>
+</div>
+<div class="viewcode-block" id="product_is_autotools"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_autotools">[docs]</a><span class="k">def</span> <span class="nf">product_is_autotools</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is compiled using the autotools</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is autotools, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
+ <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'autotools'</span>
+</div>
+<div class="viewcode-block" id="product_is_cmake"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cmake">[docs]</a><span class="k">def</span> <span class="nf">product_is_cmake</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is compiled using the cmake</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is cmake, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
+ <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'cmake'</span>
+</div>
+<div class="viewcode-block" id="product_is_vcs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_vcs">[docs]</a><span class="k">def</span> <span class="nf">product_is_vcs</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is download using git, svn or cvs (not archive)</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is vcs, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span> <span class="ow">in</span> <span class="n">AVAILABLE_VCS</span>
+</div>
+<div class="viewcode-block" id="product_is_smesh_plugin"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_smesh_plugin">[docs]</a><span class="k">def</span> <span class="nf">product_is_smesh_plugin</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is a SMESH plugin</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is a SMESH plugin, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"smesh_plugin"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">smesh_plugin</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="product_is_cpp"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cpp">[docs]</a><span class="k">def</span> <span class="nf">product_is_cpp</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is cpp</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is a cpp, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"cpp"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">cpp</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="product_compiles"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_compiles">[docs]</a><span class="k">def</span> <span class="nf">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Know if a product compiles or not </span>
+<span class="sd"> (some products do not have a compilation procedure)</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product compiles, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="ow">not</span><span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"compilation"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">compilation</span> <span class="o">==</span> <span class="s">"no"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="product_has_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has a compilation script</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product it has a compilation script, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s">"build_source"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
+ <span class="c"># Native case</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
+ <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'script'</span>
+</div>
+<div class="viewcode-block" id="product_has_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_env_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_env_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has an environment script</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product it has an environment script, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">"environ"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="s">"env_script"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">environ</span>
+</div>
+<div class="viewcode-block" id="product_has_patches"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_patches">[docs]</a><span class="k">def</span> <span class="nf">product_has_patches</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has one or more patches</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product has one or more patches</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span> <span class="s">"patches"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="p">)</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'product_has_patches </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
+ <span class="c"># if product_info.name == "XDATA": return True #test #10569</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="product_has_logo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_logo">[docs]</a><span class="k">def</span> <span class="nf">product_has_logo</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has a logo (YACSGEN generate)</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: The path of the logo if the product has a logo, else False</span>
+<span class="sd"> :rtype: Str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"logo"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">logo</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="product_has_salome_gui"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_salome_gui">[docs]</a><span class="k">def</span> <span class="nf">product_has_salome_gui</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has a SALOME gui</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product has a SALOME gui, else False</span>
+<span class="sd"> :rtype: Boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"has_salome_gui"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">has_salome_gui</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="product_is_mpi"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_mpi">[docs]</a><span class="k">def</span> <span class="nf">product_is_mpi</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product has openmpi in its dependencies</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product has openmpi inits dependencies</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">"openmpi"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span>
+</div>
+<div class="viewcode-block" id="product_is_generated"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_generated">[docs]</a><span class="k">def</span> <span class="nf">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is generated (YACSGEN)</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is generated</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s">"generate"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">generate</span> <span class="o">==</span> <span class="s">"yes"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="get_product_components"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_components">[docs]</a><span class="k">def</span> <span class="nf">get_product_components</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Get the component list to generate with the product</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: The list of names of the components</span>
+<span class="sd"> :rtype: List</span>
+<span class="sd"> </span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="k">return</span> <span class="p">[]</span>
+
+ <span class="n">compo_list</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="s">"component_name"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
+ <span class="n">compo_list</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">component_name</span>
+
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">compo_list</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
+ <span class="n">compo_list</span> <span class="o">=</span> <span class="p">[</span> <span class="n">compo_list</span> <span class="p">]</span>
+
+ <span class="k">return</span> <span class="n">compo_list</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.pyconf — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.pyconf</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+
+<span class="c"># Copyright 2004-2007 by Vinay Sajip. All Rights Reserved.</span>
+<span class="c">#</span>
+<span class="c"># Permission to use, copy, modify, and distribute this software and its</span>
+<span class="c"># documentation for any purpose and without fee is hereby granted,</span>
+<span class="c"># provided that the above copyright notice appear in all copies and that</span>
+<span class="c"># both that copyright notice and this permission notice appear in</span>
+<span class="c"># supporting documentation, and that the name of Vinay Sajip</span>
+<span class="c"># not be used in advertising or publicity pertaining to distribution</span>
+<span class="c"># of the software without specific, written prior permission.</span>
+<span class="c"># VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING</span>
+<span class="c"># ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL</span>
+<span class="c"># VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR</span>
+<span class="c"># ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span>
+<span class="c"># IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT</span>
+<span class="c"># OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span>
+
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="c"># CEA adds : </span>
+<span class="c"># Possibility to overwrites value in a pyconf file</span>
+<span class="c"># Python 3 porting</span>
+
+
+<span class="sd">"""</span>
+<span class="sd">This is a configuration module for Python.</span>
+
+<span class="sd">This module should work under Python versions >= 2.2, and cannot be used with</span>
+<span class="sd">earlier versions since it uses new-style classes.</span>
+
+<span class="sd">Development and testing has only been carried out (so far) on Python 2.3.4 and</span>
+<span class="sd">Python 2.4.2. See the test module (test_config.py) included in the</span>
+<span class="sd">U{distribution<http://www.red-dove.com/python_config.html|_blank>} (follow the</span>
+<span class="sd">download link).</span>
+
+<span class="sd">A simple example - with the example configuration file::</span>
+
+<span class="sd"> messages:</span>
+<span class="sd"> [</span>
+<span class="sd"> {</span>
+<span class="sd"> stream : `sys.stderr`</span>
+<span class="sd"> message: 'Welcome'</span>
+<span class="sd"> name: 'Harry'</span>
+<span class="sd"> }</span>
+<span class="sd"> {</span>
+<span class="sd"> stream : `sys.stdout`</span>
+<span class="sd"> message: 'Welkom'</span>
+<span class="sd"> name: 'Ruud'</span>
+<span class="sd"> }</span>
+<span class="sd"> {</span>
+<span class="sd"> stream : $messages[0].stream</span>
+<span class="sd"> message: 'Bienvenue'</span>
+<span class="sd"> name: Yves</span>
+<span class="sd"> }</span>
+<span class="sd"> ]</span>
+
+<span class="sd">a program to read the configuration would be::</span>
+
+<span class="sd"> from config import Config</span>
+
+<span class="sd"> f = file('simple.cfg')</span>
+<span class="sd"> cfg = Config(f)</span>
+<span class="sd"> for m in cfg.messages:</span>
+<span class="sd"> s = '%s, %s' % (m.message, m.name)</span>
+<span class="sd"> try:</span>
+<span class="sd"> print >> m.stream, s</span>
+<span class="sd"> except IOError, e:</span>
+<span class="sd"> print e</span>
+
+<span class="sd">which, when run, would yield the console output::</span>
+
+<span class="sd"> Welcome, Harry</span>
+<span class="sd"> Welkom, Ruud</span>
+<span class="sd"> Bienvenue, Yves</span>
+
+<span class="sd">See U{this tutorial<http://www.red-dove.com/python_config.html|_blank>} for more</span>
+<span class="sd">information.</span>
+
+<span class="sd">#modified for salomeTools</span>
+<span class="sd">@version: 0.3.7.1</span>
+
+<span class="sd">@author: Vinay Sajip</span>
+
+<span class="sd">@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</span>
+
+
+<span class="sd">@var streamOpener: The default stream opener. This is a factory function which</span>
+<span class="sd">takes a string (e.g. filename) and returns a stream suitable for reading. If</span>
+<span class="sd">unable to open the stream, an IOError exception should be thrown.</span>
+
+<span class="sd">The default value of this variable is L{defaultStreamOpener}. For an example</span>
+<span class="sd">of how it's used, see test_config.py (search for streamOpener).</span>
+<span class="sd">"""</span>
+
+<span class="n">__author__</span> <span class="o">=</span> <span class="s">"Vinay Sajip <vinay_sajip@red-dove.com>"</span>
+<span class="n">__status__</span> <span class="o">=</span> <span class="s">"alpha"</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s">"0.3.7.1"</span> <span class="c">#modified for salomeTools</span>
+<span class="n">__date__</span> <span class="o">=</span> <span class="s">"05 October 2007"</span>
+
+<span class="kn">import</span> <span class="nn">codecs</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+
+<span class="n">WORD</span> <span class="o">=</span> <span class="s">'a'</span>
+<span class="n">NUMBER</span> <span class="o">=</span> <span class="s">'9'</span>
+<span class="n">STRING</span> <span class="o">=</span> <span class="s">'"'</span>
+<span class="n">EOF</span> <span class="o">=</span> <span class="s">''</span>
+<span class="n">LCURLY</span> <span class="o">=</span> <span class="s">'{'</span>
+<span class="n">RCURLY</span> <span class="o">=</span> <span class="s">'}'</span>
+<span class="n">LBRACK</span> <span class="o">=</span> <span class="s">'['</span>
+<span class="n">LBRACK2</span> <span class="o">=</span> <span class="s">'a['</span>
+<span class="n">RBRACK</span> <span class="o">=</span> <span class="s">']'</span>
+<span class="n">LPAREN</span> <span class="o">=</span> <span class="s">'('</span>
+<span class="n">LPAREN2</span> <span class="o">=</span> <span class="s">'(('</span>
+<span class="n">RPAREN</span> <span class="o">=</span> <span class="s">')'</span>
+<span class="n">DOT</span> <span class="o">=</span> <span class="s">'.'</span>
+<span class="n">COMMA</span> <span class="o">=</span> <span class="s">','</span>
+<span class="n">COLON</span> <span class="o">=</span> <span class="s">':'</span>
+<span class="n">AT</span> <span class="o">=</span> <span class="s">'@'</span>
+<span class="n">PLUS</span> <span class="o">=</span> <span class="s">'+'</span>
+<span class="n">MINUS</span> <span class="o">=</span> <span class="s">'-'</span>
+<span class="n">STAR</span> <span class="o">=</span> <span class="s">'*'</span>
+<span class="n">SLASH</span> <span class="o">=</span> <span class="s">'/'</span>
+<span class="n">MOD</span> <span class="o">=</span> <span class="s">'%'</span>
+<span class="n">BACKTICK</span> <span class="o">=</span> <span class="s">'`'</span>
+<span class="n">DOLLAR</span> <span class="o">=</span> <span class="s">'$'</span>
+<span class="n">TRUE</span> <span class="o">=</span> <span class="s">'True'</span>
+<span class="n">FALSE</span> <span class="o">=</span> <span class="s">'False'</span>
+<span class="n">NONE</span> <span class="o">=</span> <span class="s">'None'</span>
+
+<span class="n">WORDCHARS</span> <span class="o">=</span> <span class="s">"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_"</span>
+
+<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s">'win32'</span><span class="p">:</span>
+ <span class="n">NEWLINE</span> <span class="o">=</span> <span class="s">'</span><span class="se">\r\n</span><span class="s">'</span>
+<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s">'mac'</span><span class="p">:</span>
+ <span class="n">NEWLINE</span> <span class="o">=</span> <span class="s">'</span><span class="se">\r</span><span class="s">'</span>
+<span class="k">else</span><span class="p">:</span>
+ <span class="n">NEWLINE</span> <span class="o">=</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span>
+
+<span class="k">try</span><span class="p">:</span>
+ <span class="n">has_utf32</span> <span class="o">=</span> <span class="bp">True</span>
+<span class="k">except</span><span class="p">:</span>
+ <span class="n">has_utf32</span> <span class="o">=</span> <span class="bp">False</span>
+
+<div class="viewcode-block" id="ConfigInputStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigInputStream">[docs]</a><span class="k">class</span> <span class="nc">ConfigInputStream</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> An input stream which can read either ANSI files with default encoding</span>
+<span class="sd"> or Unicode files with BOMs.</span>
+
+<span class="sd"> Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had</span>
+<span class="sd"> built-in support.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param stream: The underlying stream to be read. Should be seekable.</span>
+<span class="sd"> @type stream: A stream (file-like object).</span>
+<span class="sd"> """</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="n">signature</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
+ <span class="n">used</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
+ <span class="k">if</span> <span class="n">has_utf32</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">signature</span> <span class="o">==</span> <span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF32_LE</span><span class="p">:</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">'utf-32le'</span>
+ <span class="k">elif</span> <span class="n">signature</span> <span class="o">==</span> <span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF32_BE</span><span class="p">:</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">'utf-32be'</span>
+ <span class="k">if</span> <span class="n">encoding</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">signature</span><span class="p">[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF8</span><span class="p">:</span>
+ <span class="n">used</span> <span class="o">=</span> <span class="mi">3</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">'utf-8'</span>
+ <span class="k">elif</span> <span class="n">signature</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF16_LE</span><span class="p">:</span>
+ <span class="n">used</span> <span class="o">=</span> <span class="mi">2</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">'utf-16le'</span>
+ <span class="k">elif</span> <span class="n">signature</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF16_BE</span><span class="p">:</span>
+ <span class="n">used</span> <span class="o">=</span> <span class="mi">2</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="s">'utf-16be'</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">used</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">if</span> <span class="n">used</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">used</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">encoding</span><span class="p">:</span>
+ <span class="n">reader</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">getreader</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
+ <span class="n">stream</span> <span class="o">=</span> <span class="n">reader</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">stream</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="n">encoding</span>
+
+<div class="viewcode-block" id="ConfigInputStream.read"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigInputStream.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">size</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="s">u''</span>
+ <span class="k">while</span> <span class="n">size</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="n">size</span> <span class="o">-=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigInputStream.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigInputStream.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="ConfigInputStream.readline"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigInputStream.readline">[docs]</a> <span class="k">def</span> <span class="nf">readline</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="s">''</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="s">u''</span>
+ <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">c</span><span class="p">:</span>
+ <span class="n">line</span> <span class="o">+=</span> <span class="n">c</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">return</span> <span class="n">line</span>
+</div></div>
+<div class="viewcode-block" id="ConfigOutputStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigOutputStream">[docs]</a><span class="k">class</span> <span class="nc">ConfigOutputStream</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> An output stream which can write either ANSI files with default encoding</span>
+<span class="sd"> or Unicode files with BOMs.</span>
+
+<span class="sd"> Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had</span>
+<span class="sd"> built-in support.</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param stream: The underlying stream to be written.</span>
+<span class="sd"> @type stream: A stream (file-like object).</span>
+<span class="sd"> @param encoding: The desired encoding.</span>
+<span class="sd"> @type encoding: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">encoding</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">encoding</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="n">encoding</span>
+ <span class="k">if</span> <span class="n">encoding</span> <span class="o">==</span> <span class="s">"utf-8"</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF8</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">encoding</span> <span class="o">==</span> <span class="s">"utf-16be"</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF16_BE</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">encoding</span> <span class="o">==</span> <span class="s">"utf-16le"</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF16_LE</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">encoding</span> <span class="o">==</span> <span class="s">"utf-32be"</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF32_BE</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">encoding</span> <span class="o">==</span> <span class="s">"utf-32le"</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">codecs</span><span class="o">.</span><span class="n">BOM_UTF32_LE</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">encoding</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">writer</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">getwriter</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
+ <span class="n">stream</span> <span class="o">=</span> <span class="n">writer</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">stream</span>
+
+<div class="viewcode-block" id="ConfigOutputStream.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigOutputStream.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigOutputStream.flush"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigOutputStream.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="ConfigOutputStream.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigOutputStream.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</div></div>
+<div class="viewcode-block" id="defaultStreamOpener"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.defaultStreamOpener">[docs]</a><span class="k">def</span> <span class="nf">defaultStreamOpener</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> This function returns a read-only stream, given its name. The name passed</span>
+<span class="sd"> in should correspond to an existing stream, otherwise an exception will be</span>
+<span class="sd"> raised.</span>
+
+<span class="sd"> This is the default value of L{streamOpener}; assign your own callable to</span>
+<span class="sd"> streamOpener to return streams based on names. For example, you could use</span>
+<span class="sd"> urllib2.urlopen().</span>
+
+<span class="sd"> @param name: The name of a stream, most commonly a file name.</span>
+<span class="sd"> @type name: str</span>
+<span class="sd"> @return: A stream with the specified name.</span>
+<span class="sd"> @rtype: A read-only stream (file-like object)</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">ConfigInputStream</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s">'rb'</span><span class="p">))</span>
+</div>
+<span class="n">streamOpener</span> <span class="o">=</span> <span class="bp">None</span>
+
+<span class="n">__resolveOverwrite__</span> <span class="o">=</span> <span class="bp">True</span>
+
+<div class="viewcode-block" id="ConfigError"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigError">[docs]</a><span class="k">class</span> <span class="nc">ConfigError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This is the base class of exceptions raised by this module.</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ConfigFormatError"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigFormatError">[docs]</a><span class="k">class</span> <span class="nc">ConfigFormatError</span><span class="p">(</span><span class="n">ConfigError</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This is the base class of exceptions raised due to syntax errors in</span>
+<span class="sd"> configurations.</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="ConfigResolutionError"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigResolutionError">[docs]</a><span class="k">class</span> <span class="nc">ConfigResolutionError</span><span class="p">(</span><span class="n">ConfigError</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This is the base class of exceptions raised due to semantic errors in</span>
+<span class="sd"> configurations.</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+</div>
+<div class="viewcode-block" id="isWord"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.isWord">[docs]</a><span class="k">def</span> <span class="nf">isWord</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> See if a passed-in value is an identifier. If the value passed in is not a</span>
+<span class="sd"> string, False is returned. An identifier consists of alphanumerics or</span>
+<span class="sd"> underscore characters.</span>
+
+<span class="sd"> Examples::</span>
+
+<span class="sd"> isWord('a word') ->False</span>
+<span class="sd"> isWord('award') -> True</span>
+<span class="sd"> isWord(9) -> False</span>
+<span class="sd"> isWord('a_b_c_') ->True</span>
+
+<span class="sd"> @note: isWord('9abc') will return True - not exactly correct, but adequate</span>
+<span class="sd"> for the way it's used here.</span>
+
+<span class="sd"> @param s: The name to be tested</span>
+<span class="sd"> @type s: any</span>
+<span class="sd"> @return: True if a word, else False</span>
+<span class="sd"> @rtype: bool</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">type</span><span class="p">(</span><span class="s">''</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">False</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">'_'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">isalnum</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="makePath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.makePath">[docs]</a><span class="k">def</span> <span class="nf">makePath</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Make a path from a prefix and suffix.</span>
+
+<span class="sd"> Examples:</span>
+<span class="sd"> makePath('', 'suffix') -> 'suffix'</span>
+<span class="sd"> makePath('prefix', 'suffix') -> 'prefix.suffix'</span>
+<span class="sd"> makePath('prefix', '[1]') -> 'prefix[1]'</span>
+
+<span class="sd"> @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.</span>
+<span class="sd"> @type prefix: str</span>
+<span class="sd"> @param suffix: The suffix to use. It is either an identifier or an index in brackets.</span>
+<span class="sd"> @type suffix: str</span>
+<span class="sd"> @return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.</span>
+<span class="sd"> @rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">prefix</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">suffix</span>
+ <span class="k">elif</span> <span class="n">suffix</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'['</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">suffix</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="s">'.'</span> <span class="o">+</span> <span class="n">suffix</span>
+ <span class="k">return</span> <span class="n">rv</span>
+
+</div>
+<div class="viewcode-block" id="Container"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Container">[docs]</a><span class="k">class</span> <span class="nc">Container</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class is the base class for mappings and sequences.</span>
+
+<span class="sd"> @ivar path: A string which describes how to get</span>
+<span class="sd"> to this instance from the root of the hierarchy.</span>
+
+<span class="sd"> Example::</span>
+
+<span class="sd"> a.list.of[1].or['more'].elements</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param parent: The parent of this instance in the hierarchy.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> """</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'parent'</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
+
+<div class="viewcode-block" id="Container.setPath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Container.setPath">[docs]</a> <span class="k">def</span> <span class="nf">setPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Set the path for this instance.</span>
+<span class="sd"> @param path: The path - a string which describes how to get</span>
+<span class="sd"> to this instance from the root of the hierarchy.</span>
+<span class="sd"> @type path: str</span>
+<span class="sd"> """</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'path'</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Container.evaluate"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Container.evaluate">[docs]</a> <span class="k">def</span> <span class="nf">evaluate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Evaluate items which are instances of L{Reference} or L{Expression}.</span>
+
+<span class="sd"> L{Reference} instances are evaluated using L{Reference.resolve},</span>
+<span class="sd"> and L{Expression} instances are evaluated using</span>
+<span class="sd"> L{Expression.evaluate}.</span>
+
+<span class="sd"> @param item: The item to be evaluated.</span>
+<span class="sd"> @type item: any</span>
+<span class="sd"> @return: If the item is an instance of L{Reference} or L{Expression},</span>
+<span class="sd"> the evaluated value is returned, otherwise the item is returned</span>
+<span class="sd"> unchanged.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">Reference</span><span class="p">):</span>
+ <span class="n">item</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">resolve</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">Expression</span><span class="p">):</span>
+ <span class="n">item</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">item</span>
+</div>
+<div class="viewcode-block" id="Container.writeToStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Container.writeToStream">[docs]</a> <span class="k">def</span> <span class="nf">writeToStream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Write this instance to a stream at the specified indentation level.</span>
+
+<span class="sd"> Should be redefined in subclasses.</span>
+
+<span class="sd"> @param stream: The stream to write to</span>
+<span class="sd"> @type stream: A writable stream (file-like object)</span>
+<span class="sd"> @param indent: The indentation level</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> @param container: The container of this instance</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> @raise NotImplementedError: If a subclass does not override this</span>
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+</div>
+<div class="viewcode-block" id="Container.writeValue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Container.writeValue">[docs]</a> <span class="k">def</span> <span class="nf">writeValue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="s">' '</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Reference</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Expression</span><span class="p">):</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s%r%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> <span class="c"># and not isWord(value):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s%s%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+</div></div>
+<div class="viewcode-block" id="Mapping"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping">[docs]</a><span class="k">class</span> <span class="nc">Mapping</span><span class="p">(</span><span class="n">Container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements key-value mappings in configurations.</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param parent: The parent of this instance in the hierarchy.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> """</span>
+ <span class="n">Container</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'path'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">,</span> <span class="p">{})</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">,</span> <span class="p">[])</span> <span class="c"># to preserve ordering</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">,</span> <span class="p">{})</span>
+
+ <span class="k">def</span> <span class="nf">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Remove an item</span>
+<span class="sd"> """</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="n">comments</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+ <span class="k">del</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="n">order</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">del</span> <span class="n">comments</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+
+ <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+
+ <span class="n">__getattr__</span> <span class="o">=</span> <span class="n">__getitem__</span>
+
+ <span class="sd">'''</span>
+<span class="sd"> def __getattribute__(self, name):</span>
+<span class="sd"> if name == "__dict__":</span>
+<span class="sd"> return {}</span>
+<span class="sd"> if name in ["__methods__", "__members__"]:</span>
+<span class="sd"> return []</span>
+<span class="sd"> #if name == "__class__":</span>
+<span class="sd"> # return ''</span>
+<span class="sd"> data = object.__getattribute__(self, "data")</span>
+<span class="sd"> useData = data.has_key(name)</span>
+<span class="sd"> if useData:</span>
+<span class="sd"> rv = getattr(data, name)</span>
+<span class="sd"> else:</span>
+<span class="sd"> rv = object.__getattribute__(self, name)</span>
+<span class="sd"> if rv is None:</span>
+<span class="sd"> raise AttributeError(name)</span>
+<span class="sd"> return rv</span>
+<span class="sd"> '''</span>
+
+<div class="viewcode-block" id="Mapping.iteritems"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.iteritems">[docs]</a> <span class="k">def</span> <span class="nf">iteritems</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">yield</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>
+ <span class="k">raise</span> <span class="ne">StopIteration</span>
+</div>
+ <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">order</span>
+
+<div class="viewcode-block" id="Mapping.addMapping"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.addMapping">[docs]</a> <span class="k">def</span> <span class="nf">addMapping</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">comment</span><span class="p">,</span> <span class="n">setting</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Add a key-value mapping with a comment.</span>
+
+<span class="sd"> @param key: The key for the mapping.</span>
+<span class="sd"> @type key: str</span>
+<span class="sd"> @param value: The value for the mapping.</span>
+<span class="sd"> @type value: any</span>
+<span class="sd"> @param comment: The comment for the key (can be None).</span>
+<span class="sd"> @type comment: str</span>
+<span class="sd"> @param setting: If True, ignore clashes. This is set</span>
+<span class="sd"> to true when called from L{__setattr__}.</span>
+<span class="sd"> @raise ConfigFormatError: If an existing key is seen</span>
+<span class="sd"> again and setting is False.</span>
+<span class="sd"> """</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="n">comments</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+
+ <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">order</span><span class="p">:</span>
+ <span class="n">order</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="ow">not</span> <span class="n">setting</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"repeated key: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
+ <span class="n">comments</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">comment</span>
+</div>
+ <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
+
+ <span class="n">__setitem__</span> <span class="o">=</span> <span class="n">__setattr__</span>
+
+<div class="viewcode-block" id="Mapping.keys"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.keys">[docs]</a> <span class="k">def</span> <span class="nf">keys</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Return the keys in a similar way to a dictionary.</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Mapping.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Allows a dictionary-style get operation.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">default</span>
+</div>
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">()</span>
+
+<div class="viewcode-block" id="Mapping.iterkeys"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.iterkeys">[docs]</a> <span class="k">def</span> <span class="nf">iterkeys</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">order</span><span class="o">.</span><span class="n">__iter__</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Mapping.writeToStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Mapping.writeToStream">[docs]</a> <span class="k">def</span> <span class="nf">writeToStream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Write this instance to a stream at the specified indentation level.</span>
+
+<span class="sd"> Should be redefined in subclasses.</span>
+
+<span class="sd"> @param stream: The stream to write to</span>
+<span class="sd"> @type stream: A writable stream (file-like object)</span>
+<span class="sd"> @param indent: The indentation level</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> @param container: The container of this instance</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> """</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' { }</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">NEWLINE</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">NEWLINE</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">{</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">indent</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">}</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+</div>
+ <span class="k">def</span> <span class="nf">__save__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Save this configuration to the specified stream.</span>
+<span class="sd"> @param stream: A stream to which the configuration is written.</span>
+<span class="sd"> @type stream: A write-only stream (file-like object).</span>
+<span class="sd"> @param indent: The indentation level for the output.</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> """</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span>
+ <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'order'</span><span class="p">)</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="n">maxlen</span> <span class="o">=</span> <span class="mi">0</span> <span class="c"># max(map(lambda x: len(x), order))</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">order</span><span class="p">:</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comments</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">isWord</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
+ <span class="n">skey</span> <span class="o">=</span> <span class="n">key</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">skey</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">comment</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">#</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">comment</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">skey</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"u'"</span><span class="p">):</span>
+ <span class="n">skey</span> <span class="o">=</span> <span class="n">skey</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s%-*s</span><span class="s"> :'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">maxlen</span><span class="p">,</span> <span class="n">skey</span><span class="p">))</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Container</span><span class="p">):</span>
+ <span class="n">value</span><span class="o">.</span><span class="n">writeToStream</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">writeValue</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Config"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config">[docs]</a><span class="k">class</span> <span class="nc">Config</span><span class="p">(</span><span class="n">Mapping</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This class represents a configuration, and is the only one which clients</span>
+<span class="sd"> need to interface to, under normal circumstances.</span>
+<span class="sd"> """</span>
+
+<div class="viewcode-block" id="Config.Namespace"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config.Namespace">[docs]</a> <span class="k">class</span> <span class="nc">Namespace</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class is used for implementing default namespaces.</span>
+
+<span class="sd"> An instance acts as a namespace.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sys</span> <span class="o">=</span> <span class="n">sys</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">os</span> <span class="o">=</span> <span class="n">os</span>
+</div>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">streamOrFile</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">PWD</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initializes an instance.</span>
+
+<span class="sd"> @param streamOrFile: If specified, causes this instance to be loaded</span>
+<span class="sd"> from the stream (by calling L{load}). If a string is provided, it is</span>
+<span class="sd"> passed to L{streamOpener} to open a stream. Otherwise, the passed</span>
+<span class="sd"> value is assumed to be a stream and used as is.</span>
+<span class="sd"> @type streamOrFile: A readable stream (file-like object) or a name.</span>
+<span class="sd"> @param parent: If specified, this becomes the parent of this instance</span>
+<span class="sd"> in the configuration hierarchy.</span>
+<span class="sd"> @type parent: a L{Container} instance.</span>
+<span class="sd"> """</span>
+ <span class="k">try</span><span class="p">:</span> <span class="c"># Python 3 compatibility</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">streamOrFile</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
+ <span class="n">streamOrFile</span> <span class="o">=</span> <span class="n">streamOrFile</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>
+ <span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="n">Mapping</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'reader'</span><span class="p">,</span> <span class="n">ConfigReader</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'namespaces'</span><span class="p">,</span> <span class="p">[</span><span class="n">Config</span><span class="o">.</span><span class="n">Namespace</span><span class="p">()])</span>
+ <span class="k">if</span> <span class="n">streamOrFile</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">streamOrFile</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">streamOrFile</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="k">global</span> <span class="n">streamOpener</span>
+ <span class="k">if</span> <span class="n">streamOpener</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">streamOpener</span> <span class="o">=</span> <span class="n">defaultStreamOpener</span>
+ <span class="n">streamOrFile</span> <span class="o">=</span> <span class="n">streamOpener</span><span class="p">(</span><span class="n">streamOrFile</span><span class="p">)</span>
+ <span class="n">load</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">"load"</span><span class="p">)</span>
+ <span class="n">load</span><span class="p">(</span><span class="n">streamOrFile</span><span class="p">)</span>
+ <span class="c"># Specific add for salomeTools : PWD</span>
+ <span class="k">if</span> <span class="n">PWD</span><span class="p">:</span>
+ <span class="n">key</span><span class="p">,</span> <span class="n">pwd</span> <span class="o">=</span> <span class="n">PWD</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s">""</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">PWD</span> <span class="o">=</span> <span class="n">pwd</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">PWD</span> <span class="o">=</span> <span class="n">pwd</span>
+
+<div class="viewcode-block" id="Config.load"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Load the configuration from the specified stream. Multiple streams can</span>
+<span class="sd"> be used to populate the same instance, as long as there are no</span>
+<span class="sd"> clashing keys. The stream is closed.</span>
+<span class="sd"> @param stream: A stream from which the configuration is read.</span>
+<span class="sd"> @type stream: A read-only stream (file-like object).</span>
+<span class="sd"> @raise ConfigError: if keys in the loaded configuration clash with</span>
+<span class="sd"> existing keys.</span>
+<span class="sd"> @raise ConfigFormatError: if there is a syntax error in the stream.</span>
+<span class="sd"> """</span>
+ <span class="n">reader</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'reader'</span><span class="p">)</span>
+ <span class="n">reader</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Config.addNamespace"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config.addNamespace">[docs]</a> <span class="k">def</span> <span class="nf">addNamespace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ns</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Add a namespace to this configuration which can be used to evaluate</span>
+<span class="sd"> (resolve) dotted-identifier expressions.</span>
+<span class="sd"> @param ns: The namespace to be added.</span>
+<span class="sd"> @type ns: A module or other namespace suitable for passing as an</span>
+<span class="sd"> argument to vars().</span>
+<span class="sd"> @param name: A name for the namespace, which, if specified, provides</span>
+<span class="sd"> an additional level of indirection.</span>
+<span class="sd"> @type name: str</span>
+<span class="sd"> """</span>
+ <span class="n">namespaces</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'namespaces'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">namespaces</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ns</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">setattr</span><span class="p">(</span><span class="n">namespaces</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Config.removeNamespace"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config.removeNamespace">[docs]</a> <span class="k">def</span> <span class="nf">removeNamespace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ns</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Remove a namespace added with L{addNamespace}.</span>
+<span class="sd"> @param ns: The namespace to be removed.</span>
+<span class="sd"> @param name: The name which was specified when L{addNamespace} was</span>
+<span class="sd"> called.</span>
+<span class="sd"> @type name: str</span>
+<span class="sd"> """</span>
+ <span class="n">namespaces</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'namespaces'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">namespaces</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">ns</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">delattr</span><span class="p">(</span><span class="n">namespaces</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">name</span><span class="p">)</span>
+</div>
+ <span class="k">def</span> <span class="nf">__save__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">no_close</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Save this configuration to the specified stream. The stream is</span>
+<span class="sd"> closed if this is the top-level configuration in the hierarchy.</span>
+<span class="sd"> L{Mapping.__save__} is called to do all the work.</span>
+<span class="sd"> @param stream: A stream to which the configuration is written.</span>
+<span class="sd"> @type stream: A write-only stream (file-like object).</span>
+<span class="sd"> @param indent: The indentation level for the output.</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> """</span>
+ <span class="n">Mapping</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">indent</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">no_close</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+<div class="viewcode-block" id="Config.getByPath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Config.getByPath">[docs]</a> <span class="k">def</span> <span class="nf">getByPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Obtain a value in the configuration via its path.</span>
+<span class="sd"> @param path: The path of the required value</span>
+<span class="sd"> @type path: str</span>
+<span class="sd"> @return the value at the specified path.</span>
+<span class="sd"> @rtype: any</span>
+<span class="sd"> @raise ConfigError: If the path is invalid</span>
+<span class="sd"> """</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="s">'self.'</span> <span class="o">+</span> <span class="n">path</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">eval</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
+</div></div>
+<div class="viewcode-block" id="Sequence"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence">[docs]</a><span class="k">class</span> <span class="nc">Sequence</span><span class="p">(</span><span class="n">Container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements a value which is a sequence of other values.</span>
+<span class="sd"> """</span>
+<div class="viewcode-block" id="Sequence.SeqIter"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence.SeqIter">[docs]</a> <span class="k">class</span> <span class="nc">SeqIter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements an iterator for a L{Sequence} instance.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seq</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">seq</span> <span class="o">=</span> <span class="n">seq</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">limit</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq</span><span class="p">,</span> <span class="s">'data'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
+
+ <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span>
+
+<div class="viewcode-block" id="Sequence.SeqIter.next"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence.SeqIter.next">[docs]</a> <span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">limit</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">StopIteration</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">seq</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">rv</span>
+
+ <span class="c"># This method is for python3 compatibility</span></div>
+ <span class="k">def</span> <span class="nf">__next__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">limit</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">StopIteration</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">seq</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param parent: The parent of this instance in the hierarchy.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> """</span>
+ <span class="n">Container</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">,</span> <span class="p">[])</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">,</span> <span class="p">[])</span>
+
+<div class="viewcode-block" id="Sequence.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Add an item to the sequence.</span>
+
+<span class="sd"> @param item: The item to add.</span>
+<span class="sd"> @type item: any</span>
+<span class="sd"> @param comment: A comment for the item.</span>
+<span class="sd"> @type comment: str</span>
+<span class="sd"> """</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="n">comments</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+ <span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
+ <span class="n">comments</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">comment</span><span class="p">)</span>
+</div>
+ <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
+ <span class="k">except</span> <span class="p">(</span><span class="ne">IndexError</span><span class="p">,</span> <span class="ne">KeyError</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="n">ConfigResolutionError</span><span class="p">(</span><span class="s">'</span><span class="si">%r</span><span class="s"> is not a valid index for </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'path'</span><span class="p">)))</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># deal with a slice</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">rv</span><span class="p">:</span>
+ <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">a</span><span class="p">))</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">result</span>
+ <span class="k">return</span> <span class="n">rv</span>
+
+ <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">Sequence</span><span class="o">.</span><span class="n">SeqIter</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">))</span>
+
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">[:])</span> <span class="c"># using the slice evaluates the contents</span>
+
+ <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">))</span>
+
+<div class="viewcode-block" id="Sequence.writeToStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence.writeToStream">[docs]</a> <span class="k">def</span> <span class="nf">writeToStream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Write this instance to a stream at the specified indentation level.</span>
+
+<span class="sd"> Should be redefined in subclasses.</span>
+
+<span class="sd"> @param stream: The stream to write to</span>
+<span class="sd"> @type stream: A writable stream (file-like object)</span>
+<span class="sd"> @param indent: The indentation level</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> @param container: The container of this instance</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> """</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' [ ]</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">NEWLINE</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">NEWLINE</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">[</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">indent</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">]</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">NEWLINE</span><span class="p">))</span>
+</div>
+ <span class="k">def</span> <span class="nf">__save__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Save this instance to the specified stream.</span>
+<span class="sd"> @param stream: A stream to which the configuration is written.</span>
+<span class="sd"> @type stream: A write-only stream (file-like object).</span>
+<span class="sd"> @param indent: The indentation level for the output, > 0</span>
+<span class="sd"> @type indent: int</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">indent</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s">"sequence cannot be saved as a top-level item"</span><span class="p">)</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="n">comments</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+ <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s">' '</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="n">comments</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">comment</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">#</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">comment</span><span class="p">))</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Container</span><span class="p">):</span>
+ <span class="n">value</span><span class="o">.</span><span class="n">writeToStream</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">writeValue</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Reference"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Reference">[docs]</a><span class="k">class</span> <span class="nc">Reference</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements a value which is a reference to another value.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">ident</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param config: The configuration which contains this reference.</span>
+<span class="sd"> @type config: A L{Config} instance.</span>
+<span class="sd"> @param type: The type of reference.</span>
+<span class="sd"> @type type: BACKTICK or DOLLAR</span>
+<span class="sd"> @param ident: The identifier which starts the reference.</span>
+<span class="sd"> @type ident: str</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="nb">type</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elements</span> <span class="o">=</span> <span class="p">[</span><span class="n">ident</span><span class="p">]</span>
+
+<div class="viewcode-block" id="Reference.addElement"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Reference.addElement">[docs]</a> <span class="k">def</span> <span class="nf">addElement</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">ident</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Add an element to the reference.</span>
+
+<span class="sd"> @param type: The type of reference.</span>
+<span class="sd"> @type type: BACKTICK or DOLLAR</span>
+<span class="sd"> @param ident: The identifier which continues the reference.</span>
+<span class="sd"> @type ident: str</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elements</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="nb">type</span><span class="p">,</span> <span class="n">ident</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="Reference.findConfig"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Reference.findConfig">[docs]</a> <span class="k">def</span> <span class="nf">findConfig</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Find the closest enclosing configuration to the specified container.</span>
+
+<span class="sd"> @param container: The container to start from.</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> @return: The closest enclosing configuration, or None.</span>
+<span class="sd"> @rtype: L{Config}</span>
+<span class="sd"> """</span>
+ <span class="k">while</span> <span class="p">(</span><span class="n">container</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="n">Config</span><span class="p">):</span>
+ <span class="n">container</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="s">'parent'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">container</span>
+</div>
+<div class="viewcode-block" id="Reference.resolve"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Reference.resolve">[docs]</a> <span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Resolve this instance in the context of a container.</span>
+
+<span class="sd"> @param container: The container to resolve from.</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> @return: The resolved value.</span>
+<span class="sd"> @rtype: any</span>
+<span class="sd"> @raise ConfigResolutionError: If resolution fails.</span>
+<span class="sd"> """</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="s">'path'</span><span class="p">)</span>
+ <span class="n">current</span> <span class="o">=</span> <span class="n">container</span>
+ <span class="k">while</span> <span class="n">current</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">BACKTICK</span><span class="p">:</span>
+ <span class="n">namespaces</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">current</span><span class="p">,</span> <span class="s">'namespaces'</span><span class="p">)</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">for</span> <span class="n">ns</span> <span class="ow">in</span> <span class="n">namespaces</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="nb">vars</span><span class="p">(</span><span class="n">ns</span><span class="p">))</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">break</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">elements</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">current</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">elements</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">rv</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">break</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">pass</span>
+ <span class="n">current</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">current</span><span class="p">,</span> <span class="s">'parent'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">current</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigResolutionError</span><span class="p">(</span><span class="s">"unable to evaluate </span><span class="si">%r</span><span class="s"> in the configuration </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">elements</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">tt</span><span class="p">,</span> <span class="n">tv</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">elements</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">DOT</span><span class="p">:</span>
+ <span class="n">s</span> <span class="o">+=</span> <span class="s">'.</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">tv</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">s</span> <span class="o">+=</span> <span class="s">'[</span><span class="si">%r</span><span class="s">]'</span> <span class="o">%</span> <span class="n">tv</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">BACKTICK</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">BACKTICK</span> <span class="o">+</span> <span class="n">s</span> <span class="o">+</span> <span class="n">BACKTICK</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">DOLLAR</span> <span class="o">+</span> <span class="n">s</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Expression"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Expression">[docs]</a><span class="k">class</span> <span class="nc">Expression</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements a value which is obtained by evaluating an expression.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">op</span><span class="p">,</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialize an instance.</span>
+
+<span class="sd"> @param op: the operation expressed in the expression.</span>
+<span class="sd"> @type op: PLUS, MINUS, STAR, SLASH, MOD</span>
+<span class="sd"> @param lhs: the left-hand-side operand of the expression.</span>
+<span class="sd"> @type lhs: any Expression or primary value.</span>
+<span class="sd"> @param rhs: the right-hand-side operand of the expression.</span>
+<span class="sd"> @type rhs: any Expression or primary value.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">op</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span> <span class="o">=</span> <span class="n">lhs</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span> <span class="o">=</span> <span class="n">rhs</span>
+
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">'</span><span class="si">%r</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lhs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">op</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">()</span>
+
+<div class="viewcode-block" id="Expression.evaluate"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Expression.evaluate">[docs]</a> <span class="k">def</span> <span class="nf">evaluate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">container</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Evaluate this instance in the context of a container.</span>
+
+<span class="sd"> @param container: The container to evaluate in from.</span>
+<span class="sd"> @type container: L{Container}</span>
+<span class="sd"> @return: The evaluated value.</span>
+<span class="sd"> @rtype: any</span>
+<span class="sd"> @raise ConfigResolutionError: If evaluation fails.</span>
+<span class="sd"> @raise ZeroDivideError: If division by zero occurs.</span>
+<span class="sd"> @raise TypeError: If the operation is invalid, e.g.</span>
+<span class="sd"> subtracting one string from another.</span>
+<span class="sd"> """</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">Reference</span><span class="p">):</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="n">lhs</span><span class="o">.</span><span class="n">resolve</span><span class="p">(</span><span class="n">container</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">Expression</span><span class="p">):</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="n">lhs</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">container</span><span class="p">)</span>
+ <span class="n">rhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">Reference</span><span class="p">):</span>
+ <span class="n">rhs</span> <span class="o">=</span> <span class="n">rhs</span><span class="o">.</span><span class="n">resolve</span><span class="p">(</span><span class="n">container</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rhs</span><span class="p">,</span> <span class="n">Expression</span><span class="p">):</span>
+ <span class="n">rhs</span> <span class="o">=</span> <span class="n">rhs</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">container</span><span class="p">)</span>
+ <span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">op</span>
+ <span class="k">if</span> <span class="n">op</span> <span class="o">==</span> <span class="n">PLUS</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">lhs</span> <span class="o">+</span> <span class="n">rhs</span>
+ <span class="k">elif</span> <span class="n">op</span> <span class="o">==</span> <span class="n">MINUS</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">lhs</span> <span class="o">-</span> <span class="n">rhs</span>
+ <span class="k">elif</span> <span class="n">op</span> <span class="o">==</span> <span class="n">STAR</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">lhs</span> <span class="o">*</span> <span class="n">rhs</span>
+ <span class="k">elif</span> <span class="n">op</span> <span class="o">==</span> <span class="n">SLASH</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">lhs</span> <span class="o">/</span> <span class="n">rhs</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">lhs</span> <span class="o">%</span> <span class="n">rhs</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div></div>
+<div class="viewcode-block" id="ConfigReader"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader">[docs]</a><span class="k">class</span> <span class="nc">ConfigReader</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This internal class implements a parser for configurations.</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lineno</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">colno</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">last_token</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">commentchars</span> <span class="o">=</span> <span class="s">'#'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">whitespace</span> <span class="o">=</span> <span class="s">' </span><span class="se">\t\r\n</span><span class="s">'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">quotes</span> <span class="o">=</span> <span class="s">'</span><span class="se">\'</span><span class="s">"'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">punct</span> <span class="o">=</span> <span class="s">':-+*/%,.{}[]()@`$'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">digits</span> <span class="o">=</span> <span class="s">'0123456789'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">wordchars</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">WORDCHARS</span> <span class="c"># make a copy</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">identchars</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wordchars</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">digits</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbtokens</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="bp">None</span>
+
+<div class="viewcode-block" id="ConfigReader.location"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.location">[docs]</a> <span class="k">def</span> <span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Return the current location (filename, line, column) in the stream</span>
+<span class="sd"> as a string.</span>
+
+<span class="sd"> Used when printing error messages,</span>
+
+<span class="sd"> @return: A string representing a location in the stream being read.</span>
+<span class="sd"> @rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">(</span><span class="si">%d</span><span class="s">,</span><span class="si">%d</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lineno</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colno</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.getChar"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.getChar">[docs]</a> <span class="k">def</span> <span class="nf">getChar</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Get the next char from the stream. Update line and column numbers</span>
+<span class="sd"> appropriately.</span>
+
+<span class="sd"> @return: The next character from the stream.</span>
+<span class="sd"> @rtype: str</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">c</span><span class="p">,</span><span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">c</span><span class="p">,</span><span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">colno</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lineno</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">colno</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">c</span>
+</div>
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">"<ConfigReader at 0x</span><span class="si">%08x</span><span class="s">>"</span> <span class="o">%</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+
+ <span class="n">__str__</span> <span class="o">=</span> <span class="n">__repr__</span>
+
+<div class="viewcode-block" id="ConfigReader.getToken"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.getToken">[docs]</a> <span class="k">def</span> <span class="nf">getToken</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Get a token from the stream. String values are returned in a form</span>
+<span class="sd"> where you need to eval() the returned value to get the actual</span>
+<span class="sd"> string. The return value is (token_type, token_value).</span>
+
+<span class="sd"> Multiline string tokenizing is thanks to David Janes (BlogMatrix)</span>
+
+<span class="sd"> @return: The next token.</span>
+<span class="sd"> @rtype: A token tuple.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pbtokens</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">pbtokens</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+ <span class="n">stream</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="s">''</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">EOF</span>
+ <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'#'</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">comment</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">comment</span> <span class="o">+=</span> <span class="s">'#'</span> <span class="o">+</span> <span class="n">stream</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
+ <span class="k">else</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lineno</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">quotes</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="n">quote</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">STRING</span>
+ <span class="n">escaped</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">multiline</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">c1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">c1</span> <span class="o">==</span> <span class="n">quote</span><span class="p">:</span>
+ <span class="n">c2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">c2</span> <span class="o">==</span> <span class="n">quote</span><span class="p">:</span>
+ <span class="n">multiline</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">quote</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">quote</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c1</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c1</span><span class="p">)</span>
+ <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">c</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">c</span> <span class="o">==</span> <span class="n">quote</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">escaped</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">multiline</span> <span class="ow">or</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">token</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">6</span> <span class="ow">and</span> <span class="n">token</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">token</span><span class="p">[:</span><span class="mi">3</span><span class="p">])</span> <span class="ow">and</span> <span class="n">token</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'</span><span class="se">\\</span><span class="s">'</span><span class="p">):</span>
+ <span class="k">break</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'</span><span class="se">\\</span><span class="s">'</span><span class="p">:</span>
+ <span class="n">escaped</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">escaped</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">escaped</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">: Unterminated quoted string: </span><span class="si">%r</span><span class="s">, </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">token</span><span class="p">,</span> <span class="n">c</span><span class="p">))</span>
+ <span class="k">break</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">whitespace</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="k">continue</span>
+ <span class="k">elif</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">punct</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="o">==</span> <span class="s">']'</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">identchars</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'['</span><span class="p">:</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">LBRACK2</span>
+ <span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'('</span><span class="p">:</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">LPAREN2</span>
+ <span class="k">break</span>
+ <span class="k">elif</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">digits</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">NUMBER</span>
+ <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">digits</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">c</span>
+ <span class="k">elif</span> <span class="p">(</span><span class="n">c</span> <span class="o">==</span> <span class="s">'.'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">token</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'.'</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">c</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">c</span> <span class="ow">and</span> <span class="p">(</span><span class="n">c</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">whitespace</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
+ <span class="k">break</span>
+ <span class="k">break</span>
+ <span class="k">elif</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">wordchars</span><span class="p">:</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="n">c</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">WORD</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">while</span> <span class="n">c</span> <span class="ow">and</span> <span class="p">(</span><span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">identchars</span><span class="p">):</span>
+ <span class="n">token</span> <span class="o">+=</span> <span class="n">c</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getChar</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">c</span><span class="p">:</span> <span class="c"># and c not in self.whitespace:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pbchars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">token</span> <span class="o">==</span> <span class="s">"True"</span><span class="p">:</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">TRUE</span>
+ <span class="k">elif</span> <span class="n">token</span> <span class="o">==</span> <span class="s">"False"</span><span class="p">:</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">FALSE</span>
+ <span class="k">elif</span> <span class="n">token</span> <span class="o">==</span> <span class="s">"None"</span><span class="p">:</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="n">NONE</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">: Unexpected character: </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">c</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">token</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="o">=</span> <span class="n">token</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lastc</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">last_token</span> <span class="o">=</span> <span class="n">tt</span>
+
+ <span class="c"># Python 2.x specific unicode conversion</span>
+ <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">WORD</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">token</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
+ <span class="n">token</span> <span class="o">=</span> <span class="n">token</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'ascii'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">tt</span><span class="p">,</span> <span class="n">token</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.load"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Load the configuration from the specified stream.</span>
+
+<span class="sd"> @param stream: A stream from which to load the configuration.</span>
+<span class="sd"> @type stream: A stream (file-like object).</span>
+<span class="sd"> @param parent: The parent of the configuration (to which this reader</span>
+<span class="sd"> belongs) in the hierarchy. Specified when the configuration is</span>
+<span class="sd"> included in another one.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> @param suffix: The suffix of this configuration in the parent</span>
+<span class="sd"> configuration. Should be specified whenever the parent is not None.</span>
+<span class="sd"> @raise ConfigError: If parent is specified but suffix is not.</span>
+<span class="sd"> @raise ConfigFormatError: If there are syntax errors in the stream.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">parent</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">suffix</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s">"internal error: load called with parent but no suffix"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">setPath</span><span class="p">(</span><span class="n">makePath</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="s">'path'</span><span class="p">),</span> <span class="n">suffix</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setStream</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">parseMappingBody</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">EOF</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">: expecting EOF, found </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.setStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.setStream">[docs]</a> <span class="k">def</span> <span class="nf">setStream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Set the stream to the specified value, and prepare to read from it.</span>
+
+<span class="sd"> @param stream: A stream from which to load the configuration.</span>
+<span class="sd"> @type stream: A stream (file-like object).</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">stream</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="s">'name'</span><span class="p">):</span>
+ <span class="n">filename</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">name</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">filename</span> <span class="o">=</span> <span class="s">'?'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lineno</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">colno</span> <span class="o">=</span> <span class="mi">1</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.match"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.match">[docs]</a> <span class="k">def</span> <span class="nf">match</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Ensure that the current token type matches the specified value, and</span>
+<span class="sd"> advance to the next token.</span>
+
+<span class="sd"> @param t: The token type to match.</span>
+<span class="sd"> @type t: A valid token type.</span>
+<span class="sd"> @return: The token which was last read from the stream before this</span>
+<span class="sd"> function is called.</span>
+<span class="sd"> @rtype: a token tuple - see L{getToken}.</span>
+<span class="sd"> @raise ConfigFormatError: If the token does not match what's expected.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">t</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: expecting </span><span class="si">%s</span><span class="s">, found </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">t</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseMappingBody"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseMappingBody">[docs]</a> <span class="k">def</span> <span class="nf">parseMappingBody</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse the internals of a mapping, and add entries to the provided</span>
+<span class="sd"> L{Mapping}.</span>
+
+<span class="sd"> @param parent: The mapping to add entries to.</span>
+<span class="sd"> @type parent: A L{Mapping} instance.</span>
+<span class="sd"> """</span>
+ <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="n">WORD</span><span class="p">,</span> <span class="n">STRING</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">parseKeyValuePair</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseKeyValuePair"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseKeyValuePair">[docs]</a> <span class="k">def</span> <span class="nf">parseKeyValuePair</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a key-value pair, and add it to the provided L{Mapping}.</span>
+
+<span class="sd"> @param parent: The mapping to add entries to.</span>
+<span class="sd"> @type parent: A L{Mapping} instance.</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comment</span>
+ <span class="n">tt</span><span class="p">,</span> <span class="n">tv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">WORD</span><span class="p">:</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="n">tv</span>
+ <span class="n">suffix</span> <span class="o">=</span> <span class="n">tv</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">STRING</span><span class="p">:</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">tv</span><span class="p">)</span>
+ <span class="n">suffix</span> <span class="o">=</span> <span class="s">'[</span><span class="si">%s</span><span class="s">]'</span> <span class="o">%</span> <span class="n">tv</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">: expecting word or string, found </span><span class="si">%r</span><span class="s">"</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="n">msg</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">tv</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+ <span class="c"># for now, we allow key on its own as a short form of key : True</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">COLON</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseValue</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">parent</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">, </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">e</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="n">EOF</span><span class="p">,</span> <span class="n">WORD</span><span class="p">,</span> <span class="n">STRING</span><span class="p">,</span> <span class="n">RCURLY</span><span class="p">,</span> <span class="n">COMMA</span><span class="p">]:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">: expecting one of EOF, WORD, STRING, </span><span class="se">\</span>
+<span class="s">RCURLY, COMMA, found </span><span class="si">%r</span><span class="s">"</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="n">msg</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">COMMA</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseValue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseValue">[docs]</a> <span class="k">def</span> <span class="nf">parseValue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a value.</span>
+
+<span class="sd"> @param parent: The container to which the value will be added.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> @param suffix: The suffix for the value.</span>
+<span class="sd"> @type suffix: str</span>
+<span class="sd"> @return: The value</span>
+<span class="sd"> @rtype: any</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">STRING</span><span class="p">,</span> <span class="n">WORD</span><span class="p">,</span> <span class="n">NUMBER</span><span class="p">,</span> <span class="n">LPAREN</span><span class="p">,</span> <span class="n">DOLLAR</span><span class="p">,</span>
+ <span class="n">TRUE</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="n">NONE</span><span class="p">,</span> <span class="n">BACKTICK</span><span class="p">,</span> <span class="n">MINUS</span><span class="p">]:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseScalar</span><span class="p">()</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">LBRACK</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseSequence</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">LCURLY</span><span class="p">,</span> <span class="n">AT</span><span class="p">]:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseMapping</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: unexpected input: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span>
+ <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseSequence"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseSequence">[docs]</a> <span class="k">def</span> <span class="nf">parseSequence</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a sequence.</span>
+
+<span class="sd"> @param parent: The container to which the sequence will be added.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> @param suffix: The suffix for the value.</span>
+<span class="sd"> @type suffix: str</span>
+<span class="sd"> @return: a L{Sequence} instance representing the sequence.</span>
+<span class="sd"> @rtype: L{Sequence}</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">Sequence</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
+ <span class="n">rv</span><span class="o">.</span><span class="n">setPath</span><span class="p">(</span><span class="n">makePath</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="s">'path'</span><span class="p">),</span> <span class="n">suffix</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">LBRACK</span><span class="p">)</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comment</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">while</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">STRING</span><span class="p">,</span> <span class="n">WORD</span><span class="p">,</span> <span class="n">NUMBER</span><span class="p">,</span> <span class="n">LCURLY</span><span class="p">,</span> <span class="n">LBRACK</span><span class="p">,</span> <span class="n">LPAREN</span><span class="p">,</span> <span class="n">DOLLAR</span><span class="p">,</span>
+ <span class="n">TRUE</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="n">NONE</span><span class="p">,</span> <span class="n">BACKTICK</span><span class="p">]:</span>
+ <span class="n">suffix</span> <span class="o">=</span> <span class="s">'[</span><span class="si">%d</span><span class="s">]'</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseValue</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span>
+ <span class="n">rv</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comment</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">COMMA</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">COMMA</span><span class="p">)</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">comment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comment</span>
+ <span class="k">continue</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RBRACK</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseMapping"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseMapping">[docs]</a> <span class="k">def</span> <span class="nf">parseMapping</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a mapping.</span>
+
+<span class="sd"> @param parent: The container to which the mapping will be added.</span>
+<span class="sd"> @type parent: A L{Container} instance.</span>
+<span class="sd"> @param suffix: The suffix for the value.</span>
+<span class="sd"> @type suffix: str</span>
+<span class="sd"> @return: a L{Mapping} instance representing the mapping.</span>
+<span class="sd"> @rtype: L{Mapping}</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">LCURLY</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">LCURLY</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">Mapping</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
+ <span class="n">rv</span><span class="o">.</span><span class="n">setPath</span><span class="p">(</span>
+ <span class="n">makePath</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="s">'path'</span><span class="p">),</span> <span class="n">suffix</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">parseMappingBody</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RCURLY</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">AT</span><span class="p">)</span>
+ <span class="n">_</span><span class="p">,</span> <span class="n">fn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">STRING</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="nb">eval</span><span class="p">(</span><span class="n">fn</span><span class="p">),</span> <span class="n">parent</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseScalar"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseScalar">[docs]</a> <span class="k">def</span> <span class="nf">parseScalar</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a scalar - a terminal value such as a string or number, or</span>
+<span class="sd"> an L{Expression} or L{Reference}.</span>
+
+<span class="sd"> @return: the parsed scalar</span>
+<span class="sd"> @rtype: any scalar</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseTerm</span><span class="p">()</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">while</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">PLUS</span><span class="p">,</span> <span class="n">MINUS</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">tt</span><span class="p">)</span>
+ <span class="n">rhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseTerm</span><span class="p">()</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="n">Expression</span><span class="p">(</span><span class="n">tt</span><span class="p">,</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">)</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">lhs</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseTerm"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseTerm">[docs]</a> <span class="k">def</span> <span class="nf">parseTerm</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a term in an additive expression (a + b, a - b)</span>
+
+<span class="sd"> @return: the parsed term</span>
+<span class="sd"> @rtype: any scalar</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseFactor</span><span class="p">()</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">while</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">STAR</span><span class="p">,</span> <span class="n">SLASH</span><span class="p">,</span> <span class="n">MOD</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">tt</span><span class="p">)</span>
+ <span class="n">rhs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseFactor</span><span class="p">()</span>
+ <span class="n">lhs</span> <span class="o">=</span> <span class="n">Expression</span><span class="p">(</span><span class="n">tt</span><span class="p">,</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">)</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">lhs</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseFactor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseFactor">[docs]</a> <span class="k">def</span> <span class="nf">parseFactor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a factor in an multiplicative expression (a * b, a / b, a % b)</span>
+
+<span class="sd"> @return: the parsed factor</span>
+<span class="sd"> @rtype: any scalar</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">NUMBER</span><span class="p">,</span> <span class="n">WORD</span><span class="p">,</span> <span class="n">STRING</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="n">NONE</span><span class="p">]:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">!=</span> <span class="n">WORD</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">tt</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">LPAREN</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">LPAREN</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseScalar</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RPAREN</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">DOLLAR</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">DOLLAR</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseReference</span><span class="p">(</span><span class="n">DOLLAR</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">BACKTICK</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">BACKTICK</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseReference</span><span class="p">(</span><span class="n">BACKTICK</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">BACKTICK</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">MINUS</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">MINUS</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="o">-</span><span class="bp">self</span><span class="o">.</span><span class="n">parseScalar</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: unexpected input: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span>
+ <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseReference"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseReference">[docs]</a> <span class="k">def</span> <span class="nf">parseReference</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a reference.</span>
+
+<span class="sd"> @return: the parsed reference</span>
+<span class="sd"> @rtype: L{Reference}</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">word</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">WORD</span><span class="p">)</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">Reference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">word</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="n">DOT</span><span class="p">,</span> <span class="n">LBRACK2</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">parseSuffix</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="ConfigReader.parseSuffix"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigReader.parseSuffix">[docs]</a> <span class="k">def</span> <span class="nf">parseSuffix</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ref</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse a reference suffix.</span>
+
+<span class="sd"> @param ref: The reference of which this suffix is a part.</span>
+<span class="sd"> @type ref: L{Reference}.</span>
+<span class="sd"> @raise ConfigFormatError: if a syntax error is found.</span>
+<span class="sd"> """</span>
+ <span class="n">tt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="o">==</span> <span class="n">DOT</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">DOT</span><span class="p">)</span>
+ <span class="n">word</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">WORD</span><span class="p">)</span>
+ <span class="n">ref</span><span class="o">.</span><span class="n">addElement</span><span class="p">(</span><span class="n">DOT</span><span class="p">,</span> <span class="n">word</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">LBRACK2</span><span class="p">)</span>
+ <span class="n">tt</span><span class="p">,</span> <span class="n">tv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span>
+ <span class="k">if</span> <span class="n">tt</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="n">NUMBER</span><span class="p">,</span> <span class="n">STRING</span><span class="p">]:</span>
+ <span class="k">raise</span> <span class="n">ConfigFormatError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: expected number or string, found </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">(),</span> <span class="n">tv</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getToken</span><span class="p">()</span>
+ <span class="n">tv</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">tv</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RBRACK</span><span class="p">)</span>
+ <span class="n">ref</span><span class="o">.</span><span class="n">addElement</span><span class="p">(</span><span class="n">LBRACK</span><span class="p">,</span> <span class="n">tv</span><span class="p">)</span>
+</div></div>
+<div class="viewcode-block" id="defaultMergeResolve"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.defaultMergeResolve">[docs]</a><span class="k">def</span> <span class="nf">defaultMergeResolve</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> A default resolver for merge conflicts. </span>
+<span class="sd"> Returns a string indicating what action to take to resolve the conflict.</span>
+
+<span class="sd"> @param map1: The map being merged into.</span>
+<span class="sd"> @type map1: L{Mapping}.</span>
+<span class="sd"> @param map2: The map being used as the merge operand.</span>
+<span class="sd"> @type map2: L{Mapping}.</span>
+<span class="sd"> @param key: The key in map2 (which also exists in map1).</span>
+<span class="sd"> @type key: str</span>
+
+<span class="sd"> @return: One of "merge", "append", "mismatch" or "overwrite"</span>
+<span class="sd"> indicating what action should be taken. This should</span>
+<span class="sd"> be appropriate to the objects being merged - e.g.</span>
+<span class="sd"> there is no point returning "merge" if the two objects</span>
+<span class="sd"> are instances of L{Sequence}.</span>
+
+<span class="sd"> @rtype: str</span>
+<span class="sd"> """</span>
+ <span class="n">obj1</span> <span class="o">=</span> <span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="n">obj2</span> <span class="o">=</span> <span class="n">map2</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj2</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="s">"merge"</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj2</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">):</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="s">"append"</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="s">"mismatch"</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="overwriteMergeResolve"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.overwriteMergeResolve">[docs]</a><span class="k">def</span> <span class="nf">overwriteMergeResolve</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},</span>
+<span class="sd"> but where a "mismatch" is detected, returns "overwrite" instead.</span>
+
+<span class="sd"> @param map1: The map being merged into.</span>
+<span class="sd"> @type map1: L{Mapping}.</span>
+<span class="sd"> @param map2: The map being used as the merge operand.</span>
+<span class="sd"> @type map2: L{Mapping}.</span>
+<span class="sd"> @param key: The key in map2 (which also exists in map1).</span>
+<span class="sd"> @type key: str</span>
+<span class="sd"> """</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">defaultMergeResolve</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">rv</span> <span class="o">==</span> <span class="s">"mismatch"</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="s">"overwrite"</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="deepCopyMapping"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.deepCopyMapping">[docs]</a><span class="k">def</span> <span class="nf">deepCopyMapping</span><span class="p">(</span><span class="n">inMapping</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">Mapping</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">inMapping</span><span class="p">:</span>
+ <span class="n">res</span><span class="p">[</span><span class="n">element</span><span class="p">]</span> <span class="o">=</span> <span class="n">inMapping</span><span class="p">[</span><span class="n">element</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">res</span>
+</div>
+<div class="viewcode-block" id="ConfigMerger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger">[docs]</a><span class="k">class</span> <span class="nc">ConfigMerger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This class is used for merging two configurations. If a key exists in the</span>
+<span class="sd"> merge operand but not the merge target, then the entry is copied from the</span>
+<span class="sd"> merge operand to the merge target. If a key exists in both configurations,</span>
+<span class="sd"> then a resolver (a callable) is called to decide how to handle the</span>
+<span class="sd"> conflict.</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="o">=</span><span class="n">defaultMergeResolve</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialise an instance.</span>
+
+<span class="sd"> @param resolver:</span>
+<span class="sd"> @type resolver: A callable which takes the argument list</span>
+<span class="sd"> (map1, map2, key) where map1 is the mapping being merged into,</span>
+<span class="sd"> map2 is the merge operand and key is the clashing key. The callable</span>
+<span class="sd"> should return a string indicating how the conflict should be resolved.</span>
+<span class="sd"> For possible return values, see L{defaultMergeResolve}. The default</span>
+<span class="sd"> value preserves the old behaviour</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">resolver</span> <span class="o">=</span> <span class="n">resolver</span>
+
+<div class="viewcode-block" id="ConfigMerger.merge"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger.merge">[docs]</a> <span class="k">def</span> <span class="nf">merge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">merged</span><span class="p">,</span> <span class="n">mergee</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Merge two configurations. The second configuration is unchanged,</span>
+<span class="sd"> and the first is changed to reflect the results of the merge.</span>
+
+<span class="sd"> @param merged: The configuration to merge into.</span>
+<span class="sd"> @type merged: L{Config}.</span>
+<span class="sd"> @param mergee: The configuration to merge.</span>
+<span class="sd"> @type mergee: L{Config}.</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">mergeMapping</span><span class="p">(</span><span class="n">merged</span><span class="p">,</span> <span class="n">mergee</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigMerger.overwriteKeys"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger.overwriteKeys">[docs]</a> <span class="k">def</span> <span class="nf">overwriteKeys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">map1</span><span class="p">,</span> <span class="n">seq2</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Renint variables. The second mapping is unchanged,</span>
+<span class="sd"> and the first is changed depending the keys of the second mapping.</span>
+<span class="sd"> @param map1: The mapping to reinit keys into.</span>
+<span class="sd"> @type map1: L{Mapping}.</span>
+<span class="sd"> @param map2: The mapping container reinit information.</span>
+<span class="sd"> @type map2: L{Mapping}.</span>
+<span class="sd"> """</span>
+
+ <span class="n">overwrite_list</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq2</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">overwrite_instruction</span> <span class="ow">in</span> <span class="n">overwrite_list</span><span class="p">:</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="n">overwrite_instruction</span><span class="p">,</span> <span class="s">'parent'</span><span class="p">,</span> <span class="n">map1</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s">"__condition__"</span> <span class="ow">in</span> <span class="n">overwrite_instruction</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">overwrite_condition</span> <span class="o">=</span> <span class="n">overwrite_instruction</span><span class="p">[</span><span class="s">"__condition__"</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">eval</span><span class="p">(</span><span class="n">overwrite_condition</span><span class="p">,</span> <span class="nb">globals</span><span class="p">(),</span> <span class="n">map1</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">overwrite_instruction</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s">"__condition__"</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">exec</span><span class="p">(</span> <span class="s">'map1.'</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s">" = "</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="n">overwrite_instruction</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">exec</span><span class="p">(</span><span class="s">'map1.'</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s">" = "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">overwrite_instruction</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">overwrite_instruction</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">exec</span><span class="p">(</span><span class="s">'map1.'</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s">" = "</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="n">overwrite_instruction</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">exec</span><span class="p">(</span><span class="s">'map1.'</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s">" = "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">overwrite_instruction</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
+</div>
+<div class="viewcode-block" id="ConfigMerger.mergeMapping"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeMapping">[docs]</a> <span class="k">def</span> <span class="nf">mergeMapping</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Merge two mappings recursively. The second mapping is unchanged,</span>
+<span class="sd"> and the first is changed to reflect the results of the merge.</span>
+
+<span class="sd"> @param map1: The mapping to merge into.</span>
+<span class="sd"> @type map1: L{Mapping}.</span>
+<span class="sd"> @param map2: The mapping to merge.</span>
+<span class="sd"> @type map2: L{Mapping}.</span>
+<span class="sd"> """</span>
+ <span class="n">keys</span> <span class="o">=</span> <span class="n">map1</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+ <span class="k">global</span> <span class="n">__resolveOverwrite__</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">map2</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">__resolveOverwrite__</span> <span class="ow">and</span> <span class="n">key</span> <span class="o">==</span> <span class="s">"__overwrite__"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">overwriteKeys</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span><span class="n">map2</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>
+
+ <span class="k">elif</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span>
+ <span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">map2</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">],</span> <span class="n">Container</span><span class="p">)</span> <span class="p">:</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">],</span> <span class="s">'parent'</span><span class="p">,</span> <span class="n">map1</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">obj1</span> <span class="o">=</span> <span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="n">obj2</span> <span class="o">=</span> <span class="n">map2</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="n">decision</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">resolver</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">decision</span> <span class="o">==</span> <span class="s">"merge"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">mergeMapping</span><span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">obj2</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">decision</span> <span class="o">==</span> <span class="s">"append"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">mergeSequence</span><span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">obj2</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">decision</span> <span class="o">==</span> <span class="s">"overwrite"</span><span class="p">:</span>
+ <span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj2</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">],</span> <span class="n">Container</span><span class="p">):</span>
+ <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">],</span> <span class="s">'parent'</span><span class="p">,</span> <span class="n">map1</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">decision</span> <span class="o">==</span> <span class="s">"mismatch"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">handleMismatch</span><span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">obj2</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"unable to merge: don't know how to implement </span><span class="si">%r</span><span class="s">"</span>
+ <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span> <span class="o">%</span> <span class="n">decision</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigMerger.mergeSequence"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeSequence">[docs]</a> <span class="k">def</span> <span class="nf">mergeSequence</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seq1</span><span class="p">,</span> <span class="n">seq2</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Merge two sequences. The second sequence is unchanged,</span>
+<span class="sd"> and the first is changed to have the elements of the second</span>
+<span class="sd"> appended to it.</span>
+
+<span class="sd"> @param seq1: The sequence to merge into.</span>
+<span class="sd"> @type seq1: L{Sequence}.</span>
+<span class="sd"> @param seq2: The sequence to merge.</span>
+<span class="sd"> @type seq2: L{Sequence}.</span>
+<span class="sd"> """</span>
+ <span class="n">data1</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq1</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="n">data2</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq2</span><span class="p">,</span> <span class="s">'data'</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">data2</span><span class="p">:</span>
+ <span class="n">data1</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
+ <span class="n">comment1</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq1</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+ <span class="n">comment2</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">seq2</span><span class="p">,</span> <span class="s">'comments'</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">comment2</span><span class="p">:</span>
+ <span class="n">comment1</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="ConfigMerger.handleMismatch"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigMerger.handleMismatch">[docs]</a> <span class="k">def</span> <span class="nf">handleMismatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj1</span><span class="p">,</span> <span class="n">obj2</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Handle a mismatch between two objects.</span>
+
+<span class="sd"> @param obj1: The object to merge into.</span>
+<span class="sd"> @type obj1: any</span>
+<span class="sd"> @param obj2: The object to merge.</span>
+<span class="sd"> @type obj2: any</span>
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s">"unable to merge </span><span class="si">%r</span><span class="s"> with </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">obj1</span><span class="p">,</span> <span class="n">obj2</span><span class="p">))</span>
+</div></div>
+<div class="viewcode-block" id="ConfigList"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigList">[docs]</a><span class="k">class</span> <span class="nc">ConfigList</span><span class="p">(</span><span class="nb">list</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This class implements an ordered list of configurations and allows you</span>
+<span class="sd"> to try getting the configuration from each entry in turn, returning</span>
+<span class="sd"> the first successfully obtained value.</span>
+<span class="sd"> """</span>
+
+<div class="viewcode-block" id="ConfigList.getByPath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.ConfigList.getByPath">[docs]</a> <span class="k">def</span> <span class="nf">getByPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Obtain a value from the first configuration in the list which defines</span>
+<span class="sd"> it.</span>
+
+<span class="sd"> @param path: The path of the value to retrieve.</span>
+<span class="sd"> @type path: str</span>
+<span class="sd"> @return: The value from the earliest configuration in the list which</span>
+<span class="sd"> defines it.</span>
+<span class="sd"> @rtype: any</span>
+<span class="sd"> @raise ConfigError: If no configuration in the list has an entry with</span>
+<span class="sd"> the specified path.</span>
+<span class="sd"> """</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rv</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">getByPath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="n">found</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">break</span>
+ <span class="k">except</span> <span class="n">ConfigError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s">"unable to resolve </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rv</span></div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.system — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.system</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="sd">'''</span>
+<span class="sd">In this file : all functions that do a system call, </span>
+<span class="sd">like open a browser or an editor, or call a git command</span>
+<span class="sd">'''</span>
+
+<span class="kn">import</span> <span class="nn">subprocess</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">tarfile</span>
+
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">printcolors</span>
+
+<div class="viewcode-block" id="show_in_editor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.show_in_editor">[docs]</a><span class="k">def</span> <span class="nf">show_in_editor</span><span class="p">(</span><span class="n">editor</span><span class="p">,</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">'''open filePath using editor.</span>
+<span class="sd"> </span>
+<span class="sd"> :param editor str: The editor to use.</span>
+<span class="sd"> :param filePath str: The path to the file to open.</span>
+<span class="sd"> '''</span>
+ <span class="c"># default editor is vi</span>
+ <span class="k">if</span> <span class="n">editor</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">editor</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">editor</span> <span class="o">=</span> <span class="s">'vi'</span>
+
+ <span class="k">if</span> <span class="s">'</span><span class="si">%s</span><span class="s">'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">editor</span><span class="p">:</span>
+ <span class="n">editor</span> <span class="o">+=</span> <span class="s">' </span><span class="si">%s</span><span class="s">'</span>
+
+ <span class="k">try</span><span class="p">:</span>
+ <span class="c"># launch cmd using subprocess.Popen</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">editor</span> <span class="o">%</span> <span class="n">filePath</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'Launched command:</span><span class="se">\n</span><span class="s">'</span> <span class="o">+</span> <span class="n">cmd</span> <span class="o">+</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
+ <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Unable to edit file </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="o">%</span> <span class="n">filePath</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="git_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.git_extract">[docs]</a><span class="k">def</span> <span class="nf">git_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Extracts sources from a git repository.</span>
+<span class="sd"> </span>
+<span class="sd"> :param from_what str: The remote git repository.</span>
+<span class="sd"> :param tag str: The tag.</span>
+<span class="sd"> :param where str: The path where to extract.</span>
+<span class="sd"> :param logger Logger: The logger instance to use.</span>
+<span class="sd"> :param environment src.environment.Environ: The environment to source when</span>
+<span class="sd"> extracting.</span>
+<span class="sd"> :return: True if the extraction is successful</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+ <span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">"master"</span> <span class="ow">or</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">"HEAD"</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"git clone </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">'tag'</span><span class="p">:</span> <span class="n">tag</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># NOTICE: this command only works with recent version of git</span>
+ <span class="c"># because --work-tree does not work with an absolute path</span>
+ <span class="n">where_git</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">),</span> <span class="s">".git"</span> <span class="p">)</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"rmdir </span><span class="si">%(where)s</span><span class="s"> && git clone </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s"> && "</span> <span class="o">+</span> \
+ <span class="s">"git --git-dir=</span><span class="si">%(where_git)s</span><span class="s"> --work-tree=</span><span class="si">%(where)s</span><span class="s"> checkout </span><span class="si">%(tag)s</span><span class="s">"</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">%</span> <span class="p">{</span><span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span>
+ <span class="s">'tag'</span><span class="p">:</span> <span class="n">tag</span><span class="p">,</span>
+ <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">),</span>
+ <span class="s">'where_git'</span><span class="p">:</span> <span class="n">where_git</span> <span class="p">}</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="archive_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.archive_extract">[docs]</a><span class="k">def</span> <span class="nf">archive_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">'''Extracts sources from an archive.</span>
+<span class="sd"> </span>
+<span class="sd"> :param from_what str: The path to the archive.</span>
+<span class="sd"> :param where str: The path where to extract.</span>
+<span class="sd"> :param logger Logger: The logger instance to use.</span>
+<span class="sd"> :return: True if the extraction is successful</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">archive</span> <span class="o">=</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">from_what</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">archive</span><span class="o">.</span><span class="n">getmembers</span><span class="p">():</span>
+ <span class="n">archive</span><span class="o">.</span><span class="n">extract</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">))</span>
+ <span class="k">return</span> <span class="bp">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">commonprefix</span><span class="p">(</span><span class="n">archive</span><span class="o">.</span><span class="n">getnames</span><span class="p">())</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"archive_extract: </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">exc</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span>
+</div>
+<div class="viewcode-block" id="cvs_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.cvs_extract">[docs]</a><span class="k">def</span> <span class="nf">cvs_extract</span><span class="p">(</span><span class="n">protocol</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">product</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span>
+ <span class="n">logger</span><span class="p">,</span> <span class="n">checkout</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Extracts sources from a cvs repository.</span>
+<span class="sd"> </span>
+<span class="sd"> :param protocol str: The cvs protocol.</span>
+<span class="sd"> :param user str: The user to be used.</span>
+<span class="sd"> :param server str: The remote cvs server.</span>
+<span class="sd"> :param base str: .</span>
+<span class="sd"> :param tag str: The tag.</span>
+<span class="sd"> :param product str: The product.</span>
+<span class="sd"> :param where str: The path where to extract.</span>
+<span class="sd"> :param logger Logger: The logger instance to use.</span>
+<span class="sd"> :param checkout boolean: If true use checkout cvs.</span>
+<span class="sd"> :param environment src.environment.Environ: The environment to source when</span>
+<span class="sd"> extracting.</span>
+<span class="sd"> :return: True if the extraction is successful</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+
+ <span class="n">opttag</span> <span class="o">=</span> <span class="s">''</span>
+ <span class="k">if</span> <span class="n">tag</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">opttag</span> <span class="o">=</span> <span class="s">'-r '</span> <span class="o">+</span> <span class="n">tag</span>
+
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">'export'</span>
+ <span class="k">if</span> <span class="n">checkout</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">'checkout'</span>
+ <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">opttag</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">opttag</span> <span class="o">=</span> <span class="s">'-DNOW'</span>
+
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">protocol</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">root</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">@</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"cvs -d :</span><span class="si">%(protocol)s</span><span class="s">:</span><span class="si">%(root)s</span><span class="s"> </span><span class="si">%(command)s</span><span class="s"> -d </span><span class="si">%(where)s</span><span class="s"> </span><span class="si">%(tag)s</span><span class="s"> </span><span class="si">%(product)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'protocol'</span><span class="p">:</span> <span class="n">protocol</span><span class="p">,</span> <span class="s">'root'</span><span class="p">:</span> <span class="n">root</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">base</span><span class="p">()),</span>
+ <span class="s">'tag'</span><span class="p">:</span> <span class="n">opttag</span><span class="p">,</span> <span class="s">'product'</span><span class="p">:</span> <span class="n">product</span><span class="p">,</span> <span class="s">'command'</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">}</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"cvs -d </span><span class="si">%(root)s</span><span class="s"> </span><span class="si">%(command)s</span><span class="s"> -d </span><span class="si">%(where)s</span><span class="s"> </span><span class="si">%(tag)s</span><span class="s"> </span><span class="si">%(base)s</span><span class="s">/</span><span class="si">%(product)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'root'</span><span class="p">:</span> <span class="n">server</span><span class="p">,</span> <span class="s">'base'</span><span class="p">:</span> <span class="n">base</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">base</span><span class="p">()),</span>
+ <span class="s">'tag'</span><span class="p">:</span> <span class="n">opttag</span><span class="p">,</span> <span class="s">'product'</span><span class="p">:</span> <span class="n">product</span><span class="p">,</span> <span class="s">'command'</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">}</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+ <span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="svn_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.svn_extract">[docs]</a><span class="k">def</span> <span class="nf">svn_extract</span><span class="p">(</span><span class="n">user</span><span class="p">,</span>
+ <span class="n">from_what</span><span class="p">,</span>
+ <span class="n">tag</span><span class="p">,</span>
+ <span class="n">where</span><span class="p">,</span>
+ <span class="n">logger</span><span class="p">,</span>
+ <span class="n">checkout</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
+ <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Extracts sources from a svn repository.</span>
+<span class="sd"> </span>
+<span class="sd"> :param user str: The user to be used.</span>
+<span class="sd"> :param from_what str: The remote git repository.</span>
+<span class="sd"> :param tag str: The tag.</span>
+<span class="sd"> :param where str: The path where to extract.</span>
+<span class="sd"> :param logger Logger: The logger instance to use.</span>
+<span class="sd"> :param checkout boolean: If true use checkout svn.</span>
+<span class="sd"> :param environment src.environment.Environ: The environment to source when</span>
+<span class="sd"> extracting.</span>
+<span class="sd"> :return: True if the extraction is successful</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+ <span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">checkout</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"svn checkout --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">'user'</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)):</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"/bin/rm -rf </span><span class="si">%(where)s</span><span class="s"> && "</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
+
+ <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">"master"</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">+=</span> <span class="s">"svn export --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">'user'</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">+=</span> <span class="s">"svn export -r </span><span class="si">%(tag)s</span><span class="s"> --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'tag'</span> <span class="p">:</span> <span class="n">tag</span><span class="p">,</span> <span class="s">'remote'</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">'user'</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.template — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.template</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">string</span>
+
+<div class="viewcode-block" id="MyTemplate"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.template.MyTemplate">[docs]</a><span class="k">class</span> <span class="nc">MyTemplate</span><span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">Template</span><span class="p">):</span>
+ <span class="n">delimiter</span> <span class="o">=</span> <span class="s">'¤'</span>
+</div>
+<div class="viewcode-block" id="substitute"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.template.substitute">[docs]</a><span class="k">def</span> <span class="nf">substitute</span><span class="p">(</span><span class="n">template_file</span><span class="p">,</span> <span class="n">subst_dic</span><span class="p">):</span>
+ <span class="n">template</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">template_file</span><span class="p">,</span> <span class="s">'r'</span><span class="p">)</span>
+ <span class="n">template</span> <span class="o">=</span> <span class="n">MyTemplate</span><span class="p">(</span><span class="n">template</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
+
+ <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">safe_substitute</span><span class="p">(</span><span class="n">subst_dic</span><span class="p">)</span>
+</pre></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.test_module — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.test_module</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="c"># Python 2/3 compatibility for execfile function</span>
+<span class="k">try</span><span class="p">:</span>
+ <span class="nb">execfile</span>
+<span class="k">except</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">execfile</span><span class="p">(</span><span class="n">somefile</span><span class="p">,</span> <span class="n">global_vars</span><span class="p">,</span> <span class="n">local_vars</span><span class="p">):</span>
+ <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">somefile</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
+ <span class="n">code</span> <span class="o">=</span> <span class="nb">compile</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">somefile</span><span class="p">,</span> <span class="s">'exec'</span><span class="p">)</span>
+ <span class="k">exec</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">global_vars</span><span class="p">,</span> <span class="n">local_vars</span><span class="p">)</span>
+
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">datetime</span>
+<span class="kn">import</span> <span class="nn">shutil</span>
+<span class="kn">import</span> <span class="nn">string</span>
+<span class="kn">import</span> <span class="nn">imp</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">fork</span>
+<span class="kn">import</span> <span class="nn">src</span>
+
+<span class="c"># directories not considered as test grids</span>
+<span class="n">C_IGNORE_GRIDS</span> <span class="o">=</span> <span class="p">[</span><span class="s">'.git'</span><span class="p">,</span> <span class="s">'.svn'</span><span class="p">,</span> <span class="s">'RESSOURCES'</span><span class="p">]</span>
+
+<span class="n">DEFAULT_TIMEOUT</span> <span class="o">=</span> <span class="mi">150</span>
+
+<span class="c"># Get directory to be used for the temporary files.</span>
+<span class="c">#</span>
+<div class="viewcode-block" id="getTmpDirDEFAULT"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.getTmpDirDEFAULT">[docs]</a><span class="k">def</span> <span class="nf">getTmpDirDEFAULT</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="n">directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s">"TEMP"</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># for Linux: use /tmp/logs/{user} folder</span>
+ <span class="n">directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span> <span class="s">'/tmp'</span><span class="p">,</span> <span class="s">'logs'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s">"USER"</span><span class="p">,</span> <span class="s">"unknown"</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">directory</span>
+</div>
+<div class="viewcode-block" id="Test"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test">[docs]</a><span class="k">class</span> <span class="nc">Test</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">config</span><span class="p">,</span>
+ <span class="n">logger</span><span class="p">,</span>
+ <span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="n">testbase</span><span class="o">=</span><span class="s">""</span><span class="p">,</span>
+ <span class="n">grids</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+ <span class="n">sessions</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+ <span class="n">launcher</span><span class="o">=</span><span class="s">""</span><span class="p">,</span>
+ <span class="n">show_desktop</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">grids</span> <span class="o">=</span> <span class="n">grids</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span> <span class="o">=</span> <span class="n">tmp_working_dir</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sessions</span> <span class="o">=</span> <span class="n">sessions</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span> <span class="o">=</span> <span class="n">launcher</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">show_desktop</span> <span class="o">=</span> <span class="n">show_desktop</span>
+
+ <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepare_testbase</span><span class="p">(</span><span class="n">testbase</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">test_base_found</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="c"># Fail</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">test_base_found</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># create section for results</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">TESTS</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span> <span class="o">=</span> <span class="mi">0</span>
+
+ <span class="k">def</span> <span class="nf">_copy_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">target</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">python</span> <span class="o">>=</span> <span class="s">"2.6"</span><span class="p">:</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">copytree</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span>
+ <span class="n">symlinks</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">ignore</span><span class="o">=</span><span class="n">shutil</span><span class="o">.</span><span class="n">ignore_patterns</span><span class="p">(</span><span class="s">'.git*'</span><span class="p">,</span><span class="s">'.svn*'</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">copytree</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span>
+ <span class="n">symlinks</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
+
+<div class="viewcode-block" id="Test.prepare_testbase_from_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_dir">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase_from_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="n">testbase_dir</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"get test base from dir: </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"testbase </span><span class="si">%(name)s</span><span class="s"> (</span><span class="si">%(dir)s</span><span class="s">) does not "</span>
+ <span class="s">"exist ...</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span> <span class="s">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
+ <span class="s">'dir'</span><span class="p">:</span> <span class="n">testbase_dir</span> <span class="p">})</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_copy_dir</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'BASES'</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="Test.prepare_testbase_from_git"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_git">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase_from_git</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
+ <span class="n">testbase_name</span><span class="p">,</span>
+ <span class="n">testbase_base</span><span class="p">,</span>
+ <span class="n">testbase_tag</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s">"get test base '</span><span class="si">%(testbase)s</span><span class="s">' with '</span><span class="si">%(tag)s</span><span class="s">' tag from git</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">"testbase"</span> <span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">),</span>
+ <span class="s">"tag"</span> <span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_tag</span><span class="p">)},</span>
+ <span class="mi">3</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">set_signal</span><span class="p">():</span> <span class="c"># pragma: no cover</span>
+ <span class="sd">"""see http://bugs.python.org/issue1652"""</span>
+ <span class="kn">import</span> <span class="nn">signal</span>
+ <span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIG_DFL</span><span class="p">)</span>
+
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">"git clone --depth 1 </span><span class="si">%(base)s</span><span class="s"> </span><span class="si">%(dir)s</span><span class="s">"</span>
+ <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" && cd </span><span class="si">%(dir)s</span><span class="s">"</span>
+ <span class="k">if</span> <span class="n">testbase_tag</span><span class="o">==</span><span class="s">'master'</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" && git fetch origin </span><span class="si">%(branch)s</span><span class="s">"</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" && git fetch origin </span><span class="si">%(branch)s</span><span class="s">:</span><span class="si">%(branch)s</span><span class="s">"</span>
+ <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" && git checkout </span><span class="si">%(branch)s</span><span class="s">"</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">cmd</span> <span class="o">%</span> <span class="p">{</span> <span class="s">'branch'</span><span class="p">:</span> <span class="n">testbase_tag</span><span class="p">,</span>
+ <span class="s">'base'</span><span class="p">:</span> <span class="n">testbase_base</span><span class="p">,</span>
+ <span class="s">'dir'</span><span class="p">:</span> <span class="n">testbase_name</span> <span class="p">}</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="c"># preexec_fn not supported on windows platform</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'BASES'</span><span class="p">),</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'BASES'</span><span class="p">),</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">preexec_fn</span><span class="o">=</span><span class="n">set_signal</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Error: unable to get test base "</span>
+ <span class="s">"'</span><span class="si">%(name)s</span><span class="s">' from git '</span><span class="si">%(repo)s</span><span class="s">'."</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
+ <span class="s">'repo'</span><span class="p">:</span> <span class="n">testbase_base</span> <span class="p">})</span>
+
+ <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"git is not installed. exiting...</span><span class="se">\n</span><span class="s">"</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Test.prepare_testbase_from_svn"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_svn">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase_from_svn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="n">testbase_base</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"get test base '</span><span class="si">%s</span><span class="s">' from svn</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">def</span> <span class="nf">set_signal</span><span class="p">():</span> <span class="c"># pragma: no cover</span>
+ <span class="sd">"""see http://bugs.python.org/issue1652"""</span>
+ <span class="kn">import</span> <span class="nn">signal</span>
+ <span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIG_DFL</span><span class="p">)</span>
+
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">"svn checkout --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(base)s</span><span class="s"> </span><span class="si">%(dir)s</span><span class="s">"</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">cmd</span> <span class="o">%</span> <span class="p">{</span> <span class="s">'user'</span><span class="p">:</span> <span class="n">user</span><span class="p">,</span>
+ <span class="s">'base'</span><span class="p">:</span> <span class="n">testbase_base</span><span class="p">,</span>
+ <span class="s">'dir'</span><span class="p">:</span> <span class="n">testbase_name</span> <span class="p">}</span>
+
+ <span class="c"># Get the application environment</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Set the application environment</span><span class="se">\n</span><span class="s">"</span><span class="p">),</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">env_appli</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">Environ</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)))</span>
+ <span class="n">env_appli</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
+ <span class="c"># preexec_fn not supported on windows platform</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'BASES'</span><span class="p">),</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">cwd</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'BASES'</span><span class="p">),</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">preexec_fn</span><span class="o">=</span><span class="n">set_signal</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
+ <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">env_appli</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,)</span>
+
+ <span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Error: unable to get test base '%(nam"</span>
+ <span class="s">"e)s' from svn '</span><span class="si">%(repo)s</span><span class="s">'."</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
+ <span class="s">'repo'</span><span class="p">:</span> <span class="n">testbase_base</span> <span class="p">})</span>
+
+ <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"svn is not installed. exiting...</span><span class="se">\n</span><span class="s">"</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Configure tests base.</span></div>
+<div class="viewcode-block" id="Test.prepare_testbase"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">test_base_name</span><span class="p">):</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">print_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s">"Test base"</span><span class="p">),</span>
+ <span class="n">test_base_name</span><span class="p">,</span>
+ <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="c"># search for the test base</span>
+ <span class="n">test_base_info</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">for</span> <span class="n">project_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">:</span>
+ <span class="n">project_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">[</span><span class="n">project_name</span><span class="p">]</span>
+ <span class="k">if</span> <span class="s">"test_bases"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">project_info</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">for</span> <span class="n">t_b_info</span> <span class="ow">in</span> <span class="n">project_info</span><span class="o">.</span><span class="n">test_bases</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">t_b_info</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">test_base_name</span><span class="p">:</span>
+ <span class="n">test_base_info</span> <span class="o">=</span> <span class="n">t_b_info</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">test_base_info</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">test_base_name</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepare_testbase_from_dir</span><span class="p">(</span><span class="s">"DIR"</span><span class="p">,</span> <span class="n">test_base_name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span> <span class="o">=</span> <span class="s">"DIR"</span>
+ <span class="k">return</span> <span class="mi">0</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">test_base_info</span><span class="p">:</span>
+ <span class="n">message</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"########## ERROR: test base '</span><span class="si">%s</span><span class="s">' not found</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="n">test_base_name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">message</span><span class="p">))</span>
+ <span class="k">return</span> <span class="mi">1</span>
+
+ <span class="k">if</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span> <span class="o">==</span> <span class="s">"dir"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepare_testbase_from_dir</span><span class="p">(</span><span class="n">test_base_name</span><span class="p">,</span>
+ <span class="n">test_base_info</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">dir</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span> <span class="o">==</span> <span class="s">"git"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepare_testbase_from_git</span><span class="p">(</span><span class="n">test_base_name</span><span class="p">,</span>
+ <span class="n">test_base_info</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">base</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">test_base</span><span class="o">.</span><span class="n">tag</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span> <span class="o">==</span> <span class="s">"svn"</span><span class="p">:</span>
+ <span class="n">svn_user</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_cfg_param</span><span class="p">(</span><span class="n">test_base_info</span><span class="o">.</span><span class="n">info</span><span class="p">,</span>
+ <span class="s">"svn_user"</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">svn_user</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">prepare_testbase_from_svn</span><span class="p">(</span><span class="n">svn_user</span><span class="p">,</span>
+ <span class="n">test_base_name</span><span class="p">,</span>
+ <span class="n">test_base_info</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">base</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"unknown source type '</span><span class="si">%(type)s</span><span class="s">' for test b"</span>
+ <span class="s">"ase '</span><span class="si">%(base)s</span><span class="s">' ...</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'type'</span><span class="p">:</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span><span class="p">,</span>
+ <span class="s">'base'</span><span class="p">:</span> <span class="n">test_base_name</span> <span class="p">})</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span> <span class="o">=</span> <span class="n">test_base_name</span>
+
+ <span class="c">##</span>
+ <span class="c"># Searches if the script is declared in known errors pyconf.</span>
+ <span class="c"># Update the status if needed.</span></div>
+<div class="viewcode-block" id="Test.search_known_errors"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.search_known_errors">[docs]</a> <span class="k">def</span> <span class="nf">search_known_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">,</span> <span class="n">test_grid</span><span class="p">,</span> <span class="n">test_session</span><span class="p">,</span> <span class="n">test</span><span class="p">):</span>
+ <span class="n">test_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">test_grid</span><span class="p">,</span> <span class="n">test_session</span><span class="p">,</span> <span class="n">test</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">src</span><span class="o">.</span><span class="n">config_has_application</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">status</span><span class="p">,</span> <span class="p">[]</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">status</span><span class="p">,</span> <span class="p">[]</span>
+
+ <span class="n">platform</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">arch</span>
+ <span class="n">application</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span>
+ <span class="n">error</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span><span class="o">.</span><span class="n">get_error</span><span class="p">(</span><span class="n">test_path</span><span class="p">,</span> <span class="n">application</span><span class="p">,</span> <span class="n">platform</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">error</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">status</span><span class="p">,</span> <span class="p">[]</span>
+
+ <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">error</span><span class="o">.</span><span class="n">fixed</span><span class="p">:</span>
+ <span class="c"># the error is fixed</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span><span class="o">.</span><span class="n">fix_error</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
+ <span class="c">#import testerror</span>
+ <span class="c">#testerror.write_test_failures(</span>
+ <span class="c"># self.config.TOOLS.testerror.file_path,</span>
+ <span class="c"># self.known_errors.errors)</span>
+ <span class="k">return</span> <span class="n">status</span><span class="p">,</span> <span class="p">[</span> <span class="n">error</span><span class="o">.</span><span class="n">date</span><span class="p">,</span>
+ <span class="n">error</span><span class="o">.</span><span class="n">expected</span><span class="p">,</span>
+ <span class="n">error</span><span class="o">.</span><span class="n">comment</span><span class="p">,</span>
+ <span class="n">error</span><span class="o">.</span><span class="n">fixed</span> <span class="p">]</span>
+
+ <span class="k">if</span> <span class="n">error</span><span class="o">.</span><span class="n">fixed</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span><span class="o">.</span><span class="n">unfix_error</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
+ <span class="c">#import testerror</span>
+ <span class="c">#testerror.write_test_failures(self.config.TOOLS.testerror.file_path,</span>
+ <span class="c"># self.known_errors.errors)</span>
+
+ <span class="n">delta</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span><span class="o">.</span><span class="n">get_expecting_days</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
+ <span class="n">kfres</span> <span class="o">=</span> <span class="p">[</span> <span class="n">error</span><span class="o">.</span><span class="n">date</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">expected</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">comment</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">fixed</span> <span class="p">]</span>
+ <span class="k">if</span> <span class="n">delta</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span><span class="p">,</span> <span class="n">kfres</span>
+ <span class="k">return</span> <span class="n">src</span><span class="o">.</span><span class="n">KNOWNFAILURE_STATUS</span><span class="p">,</span> <span class="n">kfres</span>
+
+ <span class="c">##</span>
+ <span class="c"># Read the *.result.py files.</span></div>
+<div class="viewcode-block" id="Test.read_results"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.read_results">[docs]</a> <span class="k">def</span> <span class="nf">read_results</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listTest</span><span class="p">,</span> <span class="n">has_timed_out</span><span class="p">):</span>
+ <span class="n">results</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">test</span> <span class="ow">in</span> <span class="n">listTest</span><span class="p">:</span>
+ <span class="n">resfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">,</span>
+ <span class="n">test</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">+</span> <span class="s">".result.py"</span><span class="p">)</span>
+
+ <span class="c"># check if <test>.result.py file exists</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">resfile</span><span class="p">):</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">"?"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s">""</span><span class="p">,</span> <span class="p">[]]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span> <span class="o">=</span> <span class="p">{},</span> <span class="p">{}</span>
+ <span class="nb">execfile</span><span class="p">(</span><span class="n">resfile</span><span class="p">,</span> <span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span><span class="p">)</span>
+
+ <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">TIMEOUT_STATUS</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">has_timed_out</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span>
+
+ <span class="k">if</span> <span class="n">ldic</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s">'status'</span><span class="p">):</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s">'status'</span><span class="p">]</span>
+
+ <span class="n">expected</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span> <span class="ow">or</span> <span class="n">status</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span><span class="p">:</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">expected</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_known_errors</span><span class="p">(</span><span class="n">status</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">,</span>
+ <span class="n">test</span><span class="p">)</span>
+
+ <span class="n">callback</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="k">if</span> <span class="n">ldic</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s">'callback'</span><span class="p">):</span>
+ <span class="n">callback</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s">'callback'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">status</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span><span class="p">:</span>
+ <span class="n">callback</span> <span class="o">=</span> <span class="s">"CRASH"</span>
+
+ <span class="n">exec_time</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
+ <span class="k">if</span> <span class="n">ldic</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s">'time'</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">exec_time</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">ldic</span><span class="p">[</span><span class="s">'time'</span><span class="p">])</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">pass</span>
+
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">status</span><span class="p">,</span> <span class="n">exec_time</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">expected</span><span class="p">]</span>
+
+ <span class="c"># check if <test>.py file exists</span>
+ <span class="n">testfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">,</span>
+ <span class="n">test</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">testfile</span><span class="p">):</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">testfile</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+ <span class="c"># check if <test>.out.py file exists</span>
+ <span class="n">outfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">,</span>
+ <span class="n">test</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">+</span> <span class="s">".out.py"</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">outfile</span><span class="p">):</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">text</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">outfile</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">test</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">results</span>
+
+ <span class="c">##</span>
+ <span class="c"># Generates the script to be run by Salome.</span>
+ <span class="c"># This python script includes init and close statements and a loop</span>
+ <span class="c"># calling all the scripts of a single directory.</span></div>
+<div class="viewcode-block" id="Test.generate_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.generate_script">[docs]</a> <span class="k">def</span> <span class="nf">generate_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listTest</span><span class="p">,</span> <span class="n">script_path</span><span class="p">,</span> <span class="n">ignoreList</span><span class="p">):</span>
+ <span class="c"># open template file</span>
+ <span class="n">template_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span>
+ <span class="s">"test"</span><span class="p">,</span>
+ <span class="s">"scriptTemplate.py"</span><span class="p">),</span> <span class="s">'r'</span><span class="p">)</span>
+ <span class="n">template</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">Template</span><span class="p">(</span><span class="n">template_file</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
+
+ <span class="c"># create substitution dictionary</span>
+ <span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'resourcesWay'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="s">'RESSOURCES'</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'tmpDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">'WORK'</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'toolsWay'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span> <span class="s">"test"</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'sessionDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'resultFile'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="s">'WORK'</span><span class="p">,</span>
+ <span class="s">'exec_result'</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'listTest'</span><span class="p">]</span> <span class="o">=</span> <span class="n">listTest</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'sessionName'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span>
+ <span class="n">d</span><span class="p">[</span><span class="s">'ignore'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ignoreList</span>
+
+ <span class="c"># create script with template</span>
+ <span class="n">script</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">script_path</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span>
+ <span class="n">script</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">template</span><span class="o">.</span><span class="n">safe_substitute</span><span class="p">(</span><span class="n">d</span><span class="p">))</span>
+ <span class="n">script</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="c"># Find the getTmpDir function that gives access to *pidict file directory.</span>
+ <span class="c"># (the *pidict file exists when SALOME is launched) </span></div>
+<div class="viewcode-block" id="Test.get_tmp_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.get_tmp_dir">[docs]</a> <span class="k">def</span> <span class="nf">get_tmp_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c"># Rare case where there is no KERNEL in grid list </span>
+ <span class="c"># (for example MED_STANDALONE)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">'APPLICATION'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span>
+ <span class="ow">and</span> <span class="s">'KERNEL'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span>
+ <span class="ow">and</span> <span class="s">'KERNEL_ROOT_DIR'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">getTmpDirDEFAULT</span>
+
+ <span class="c"># Case where "sat test" is launched in an existing SALOME environment</span>
+ <span class="k">if</span> <span class="s">'KERNEL_ROOT_DIR'</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="n">root_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'KERNEL_ROOT_DIR'</span><span class="p">]</span>
+
+ <span class="k">if</span> <span class="p">(</span><span class="s">'APPLICATION'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span>
+ <span class="ow">and</span> <span class="s">'KERNEL'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">):</span>
+ <span class="n">root_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
+ <span class="s">"KERNEL"</span><span class="p">)</span><span class="o">.</span><span class="n">install_dir</span>
+
+ <span class="c"># Case where there the appli option is called (with path to launcher)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c"># There are two cases : The old application (runAppli) </span>
+ <span class="c"># and the new one</span>
+ <span class="n">launcherName</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span>
+ <span class="n">launcherDir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">launcherName</span> <span class="o">==</span> <span class="s">'runAppli'</span><span class="p">:</span>
+ <span class="c"># Old application</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"for i in "</span> <span class="o">+</span> <span class="n">launcherDir</span> <span class="o">+</span> <span class="s">"/env.d/*.sh; do source ${i};"</span>
+ <span class="s">" done ; echo $KERNEL_ROOT_DIR"</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># New application</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"echo -e 'import os</span><span class="se">\n</span><span class="s">print os.environ[</span><span class="se">\"</span><span class="s">KERNEL_"</span> <span class="o">+</span>
+ <span class="s">"ROOT_DIR</span><span class="se">\"</span><span class="s">]' > tmpscript.py; </span><span class="si">%s</span><span class="s"> shell"</span> <span class="o">+</span>
+ <span class="s">" tmpscript.py"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span>
+
+ <span class="c"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
+ <span class="c"># de remontee de log des tests</span>
+ <span class="c">#root_dir = subprocess.Popen(cmd,</span>
+ <span class="c"># stdout=subprocess.PIPE,</span>
+ <span class="c"># shell=True,</span>
+ <span class="c"># executable='/bin/bash').communicate()[0].split()[-1]</span>
+ <span class="n">subproc_res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
+ <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
+ <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
+ <span class="n">executable</span><span class="o">=</span><span class="s">'/bin/bash'</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="c">#print "TRACES OP - test_module.py/Test.get_tmp_dir() subproc_res = "</span>
+ <span class="k">for</span> <span class="n">resLine</span> <span class="ow">in</span> <span class="n">subproc_res</span><span class="p">:</span>
+ <span class="k">print</span> <span class="s">"- '#</span><span class="si">%s</span><span class="s">#'"</span> <span class="o">%</span><span class="n">resLine</span>
+
+ <span class="n">root_dir</span> <span class="o">=</span> <span class="n">subproc_res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+
+ <span class="c"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
+ <span class="c"># de remontee de log des tests</span>
+ <span class="c">#print "TRACES OP - test_module.py/Test.get_tmp_dir() root_dir = '#%s#'" %root_dir</span>
+
+ <span class="c"># import grid salome_utils from KERNEL that gives </span>
+ <span class="c"># the right getTmpDir function</span>
+ <span class="p">(</span><span class="n">file_</span><span class="p">,</span> <span class="n">pathname</span><span class="p">,</span> <span class="n">description</span><span class="p">)</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">find_module</span><span class="p">(</span><span class="s">"salome_utils"</span><span class="p">,</span>
+ <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root_dir</span><span class="p">,</span>
+ <span class="s">'bin'</span><span class="p">,</span>
+ <span class="s">'salome'</span><span class="p">)])</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">grid</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_module</span><span class="p">(</span><span class="s">"salome_utils"</span><span class="p">,</span>
+ <span class="n">file_</span><span class="p">,</span>
+ <span class="n">pathname</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">grid</span><span class="o">.</span><span class="n">getLogDir</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">grid</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_module</span><span class="p">(</span><span class="s">"salome_utils"</span><span class="p">,</span>
+ <span class="n">file_</span><span class="p">,</span>
+ <span class="n">pathname</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">grid</span><span class="o">.</span><span class="n">getTmpDir</span>
+ <span class="k">finally</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">file_</span><span class="p">:</span>
+ <span class="n">file_</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+</div>
+<div class="viewcode-block" id="Test.get_test_timeout"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.get_test_timeout">[docs]</a> <span class="k">def</span> <span class="nf">get_test_timeout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">test_name</span><span class="p">,</span> <span class="n">default_value</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">"timeout"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="ow">and</span>
+ <span class="n">test_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s">"timeout"</span><span class="p">]):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s">"timeout"</span><span class="p">][</span><span class="n">test_name</span><span class="p">]</span>
+
+ <span class="k">return</span> <span class="n">default_value</span>
+</div>
+<div class="viewcode-block" id="Test.generate_launching_commands"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.generate_launching_commands">[docs]</a> <span class="k">def</span> <span class="nf">generate_launching_commands</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c"># Case where "sat test" is launched in an existing SALOME environment</span>
+ <span class="k">if</span> <span class="s">'KERNEL_ROOT_DIR'</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="s">"runSalome"</span>
+ <span class="n">binPython</span> <span class="o">=</span> <span class="s">"python"</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="s">"killSalome.py"</span>
+
+ <span class="c"># Rare case where there is no KERNEL in grid list </span>
+ <span class="c"># (for example MED_STANDALONE)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">'APPLICATION'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">and</span>
+ <span class="s">'KERNEL'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">):</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="s">"runSalome"</span>
+ <span class="n">binPython</span> <span class="o">=</span> <span class="s">"python"</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="s">"killSalome.py"</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">load_environment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+
+ <span class="c"># Case where there the appli option is called (with path to launcher)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c"># There are two cases : The old application (runAppli) </span>
+ <span class="c"># and the new one</span>
+ <span class="n">launcherName</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span>
+ <span class="n">launcherDir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">launcher</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">launcherName</span> <span class="o">==</span> <span class="s">'runAppli'</span><span class="p">:</span>
+ <span class="c"># Old application</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span>
+ <span class="n">binPython</span> <span class="o">=</span> <span class="p">(</span><span class="s">"for i in "</span> <span class="o">+</span>
+ <span class="n">launcherDir</span> <span class="o">+</span>
+ <span class="s">"/env.d/*.sh; do source ${i}; done ; python"</span><span class="p">)</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="p">(</span><span class="s">"for i in "</span> <span class="o">+</span>
+ <span class="n">launcherDir</span> <span class="o">+</span>
+ <span class="s">"/env.d/*.sh; do source ${i}; done ; killSalome.py'"</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># New application</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span>
+ <span class="n">binPython</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span> <span class="o">+</span> <span class="s">' shell'</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">launcher</span> <span class="o">+</span> <span class="s">' killall'</span>
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+
+ <span class="c"># SALOME version detection and APPLI repository detection</span>
+ <span class="n">VersionSalome</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_salome_version</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">appdir</span> <span class="o">=</span> <span class="s">'APPLI'</span>
+ <span class="k">if</span> <span class="s">"APPLI"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">and</span> <span class="s">"application_name"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLI</span><span class="p">:</span>
+ <span class="n">appdir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLI</span><span class="o">.</span><span class="n">application_name</span>
+
+ <span class="c"># Case where SALOME has NOT the launcher that uses the SalomeContext API</span>
+ <span class="k">if</span> <span class="n">VersionSalome</span> <span class="o"><</span> <span class="mi">730</span><span class="p">:</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="n">appdir</span><span class="p">,</span>
+ <span class="s">"runAppli"</span><span class="p">)</span>
+ <span class="n">binPython</span> <span class="o">=</span> <span class="s">"python"</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="s">"killSalome.py"</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">load_environment</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+
+ <span class="c"># Case where SALOME has the launcher that uses the SalomeContext API</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">launcher_name</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_launcher_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
+ <span class="n">launcher_name</span><span class="p">)</span>
+
+ <span class="n">binPython</span> <span class="o">=</span> <span class="n">binSalome</span> <span class="o">+</span> <span class="s">' shell'</span>
+ <span class="n">killSalome</span> <span class="o">=</span> <span class="n">binSalome</span> <span class="o">+</span> <span class="s">' killall'</span>
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+
+ <span class="k">return</span> <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span>
+
+
+ <span class="c">##</span>
+ <span class="c"># Runs tests of a session (using a single instance of Salome).</span></div>
+<div class="viewcode-block" id="Test.run_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listTest</span><span class="p">,</span> <span class="n">ignoreList</span><span class="p">):</span>
+ <span class="n">out_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">)</span>
+ <span class="n">sessionname</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">)</span>
+ <span class="n">time_out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_test_timeout</span><span class="p">(</span><span class="n">sessionname</span><span class="p">,</span>
+ <span class="n">DEFAULT_TIMEOUT</span><span class="p">)</span>
+
+ <span class="n">time_out_salome</span> <span class="o">=</span> <span class="n">DEFAULT_TIMEOUT</span>
+
+ <span class="c"># generate wrapper script</span>
+ <span class="n">script_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out_path</span><span class="p">,</span> <span class="s">'wrapperScript.py'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">generate_script</span><span class="p">(</span><span class="n">listTest</span><span class="p">,</span> <span class="n">script_path</span><span class="p">,</span> <span class="n">ignoreList</span><span class="p">)</span>
+
+ <span class="n">tmpDir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_tmp_dir</span><span class="p">()</span>
+
+ <span class="n">binSalome</span><span class="p">,</span> <span class="n">binPython</span><span class="p">,</span> <span class="n">killSalome</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_launching_commands</span><span class="p">()</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s">"run_with_grids"</span><span class="p">)</span> \
+ <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s">"run_with_grids"</span><span class="p">]</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">sessionname</span><span class="p">):</span>
+ <span class="n">binSalome</span> <span class="o">=</span> <span class="p">(</span><span class="n">binSalome</span> <span class="o">+</span>
+ <span class="s">" -m </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s">"run_with_grids"</span><span class="p">][</span><span class="n">sessionname</span><span class="p">])</span>
+
+ <span class="n">logWay</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s">"WORK"</span><span class="p">,</span> <span class="s">"log_cxx"</span><span class="p">)</span>
+
+ <span class="n">status</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="n">elapsed</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"NOGUI_"</span><span class="p">):</span>
+ <span class="c"># runSalome -t (bash)</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span><span class="n">binSalome</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="s">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span> <span class="s">"-t"</span><span class="p">,</span>
+ <span class="s">"--shutdown-server=1"</span><span class="p">,</span>
+ <span class="n">script_path</span> <span class="p">],</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span>
+ <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"PY_"</span><span class="p">):</span>
+ <span class="c"># python script.py</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span><span class="n">binPython</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="s">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span><span class="n">script_path</span><span class="p">],</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">)</span>
+
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">opt</span> <span class="o">=</span> <span class="s">"-z 0"</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">show_desktop</span><span class="p">:</span> <span class="n">opt</span> <span class="o">=</span> <span class="s">"--show-desktop=0"</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch_salome</span><span class="p">(</span><span class="n">binSalome</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="s">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span> <span class="n">opt</span><span class="p">,</span>
+ <span class="s">"--shutdown-server=1"</span><span class="p">,</span>
+ <span class="n">script_path</span> <span class="p">],</span>
+ <span class="n">getTmpDir</span><span class="o">=</span><span class="n">tmpDir</span><span class="p">,</span>
+ <span class="n">fin</span><span class="o">=</span><span class="n">killSalome</span><span class="p">,</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span>
+ <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">,</span>
+ <span class="n">delaiapp</span><span class="o">=</span><span class="n">time_out_salome</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"status = </span><span class="si">%s</span><span class="s">, elapsed = </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span><span class="p">),</span>
+ <span class="mi">5</span><span class="p">)</span>
+
+ <span class="c"># create the test result to add in the config object</span>
+ <span class="n">test_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">testbase</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">script</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+
+ <span class="n">script_results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_results</span><span class="p">(</span><span class="n">listTest</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">==</span> <span class="n">time_out</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">script_results</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">+=</span> <span class="mi">1</span>
+
+ <span class="c"># create script result</span>
+ <span class="n">script_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">sr</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">TIMEOUT_STATUS</span><span class="p">:</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">time_out</span>
+ <span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o"><</span> <span class="mf">1e-3</span><span class="p">:</span> <span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="mi">0</span>
+
+ <span class="n">callback</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">!=</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="n">callback</span>
+
+ <span class="n">kfres</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">3</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">kfres</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">date</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">expected</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
+
+ <span class="n">script_info</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">out</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">5</span><span class="p">]</span>
+
+ <span class="c"># add it to the list of results</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">script</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">script_info</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+
+ <span class="c"># display the results</span>
+ <span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">exectime</span> <span class="o">=</span> <span class="s">"(</span><span class="si">%7.3f</span><span class="s"> s)"</span> <span class="o">%</span> <span class="n">script_info</span><span class="o">.</span><span class="n">time</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">exectime</span> <span class="o">=</span> <span class="s">""</span>
+
+ <span class="n">sp</span> <span class="o">=</span> <span class="s">"."</span> <span class="o">*</span> <span class="p">(</span><span class="mi">35</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"script </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">),</span>
+ <span class="n">sp</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printc</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">res</span><span class="p">),</span>
+ <span class="n">exectime</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">script_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"Exception in </span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="n">callback</span><span class="p">)),</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">KNOWNFAILURE_STATUS</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">TIMEOUT_STATUS</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">NA_STATUS</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="s">"?"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span> <span class="o">+=</span> <span class="mi">1</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">TESTS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">test_info</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs all tests of a session.</span></div>
+<div class="viewcode-block" id="Test.run_session_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_session_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_session_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"Session = </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="c"># prepare list of tests to run</span>
+ <span class="n">tests</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">))</span>
+ <span class="n">tests</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".py"</span><span class="p">),</span> <span class="n">tests</span><span class="p">)</span>
+ <span class="n">tests</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">tests</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">lower</span><span class="p">)</span>
+
+ <span class="c"># build list of known failures</span>
+ <span class="n">cat</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">)</span>
+ <span class="n">ignoreDict</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">cat</span><span class="p">):</span>
+ <span class="n">ignoreDict</span><span class="p">[</span><span class="n">k</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">cat</span><span class="p">):]]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_tests</span><span class="p">(</span><span class="n">tests</span><span class="p">,</span> <span class="n">ignoreDict</span><span class="p">)</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs all tests of a grid.</span></div>
+<div class="viewcode-block" id="Test.run_grid_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_grid_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_grid_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"grid = </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="n">grid_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">)</span>
+
+ <span class="n">sessions</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessions</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">sessions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessions</span> <span class="c"># user choice</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># use all scripts in grid</span>
+ <span class="n">sessions</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">C_IGNORE_GRIDS</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">grid_path</span><span class="p">))</span>
+ <span class="n">sessions</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">grid_path</span><span class="p">,</span>
+ <span class="n">l</span><span class="p">)),</span> <span class="n">sessions</span><span class="p">)</span>
+
+ <span class="n">sessions</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">sessions</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">lower</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">session_</span> <span class="ow">in</span> <span class="n">sessions</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">grid_path</span><span class="p">,</span> <span class="n">session_</span><span class="p">)):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s">"Session </span><span class="si">%s</span><span class="s"> not"</span>
+ <span class="s">" found"</span> <span class="o">%</span> <span class="n">session_</span><span class="p">)</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span> <span class="o">=</span> <span class="n">session_</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_session_tests</span><span class="p">()</span>
+
+ <span class="c">##</span>
+ <span class="c"># Runs test testbase.</span></div>
+<div class="viewcode-block" id="Test.run_testbase_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_testbase_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_testbase_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">res_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="s">"RESSOURCES"</span><span class="p">)</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'PYTHONPATH'</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">res_dir</span> <span class="o">+</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">pathsep</span> <span class="o">+</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'PYTHONPATH'</span><span class="p">])</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'TT_BASE_RESSOURCES'</span><span class="p">]</span> <span class="o">=</span> <span class="n">res_dir</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">print_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="s">"TT_BASE_RESSOURCES"</span><span class="p">,</span>
+ <span class="n">res_dir</span><span class="p">,</span>
+ <span class="mi">4</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">testbase_label</span> <span class="o">=</span> <span class="s">"Test base = </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"-"</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">)),</span>
+ <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="c"># load settings</span>
+ <span class="n">settings_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res_dir</span><span class="p">,</span> <span class="s">"test_settings.py"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">settings_file</span><span class="p">):</span>
+ <span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span> <span class="o">=</span> <span class="p">{},</span> <span class="p">{}</span>
+ <span class="nb">execfile</span><span class="p">(</span><span class="n">settings_file</span><span class="p">,</span> <span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Load test settings</span><span class="se">\n</span><span class="s">"</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s">'settings_dic'</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s">'known_failures_list'</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s">"known_failur"</span>
+ <span class="s">"es_list must be a dictionary (not a list)"</span><span class="p">)</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
+
+ <span class="c"># read known failures pyconf</span>
+ <span class="k">if</span> <span class="s">"testerror"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">LOCAL</span><span class="p">:</span>
+ <span class="c">#import testerror</span>
+ <span class="c">#self.known_errors = testerror.read_test_failures(</span>
+ <span class="c"># self.config.TOOLS.testerror.file_path,</span>
+ <span class="c"># do_error=False)</span>
+ <span class="k">pass</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">grids</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">grids</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grids</span> <span class="c"># given by user</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># select all the grids (i.e. directories) in the directory</span>
+ <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">C_IGNORE_GRIDS</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">))</span>
+ <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="n">l</span><span class="p">)),</span>
+ <span class="n">grids</span><span class="p">)</span>
+
+ <span class="n">grids</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">grids</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">lower</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">grid</span> <span class="ow">in</span> <span class="n">grids</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="n">grid</span><span class="p">)):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span>
+ <span class="s">"grid </span><span class="si">%s</span><span class="s"> does not exist</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">grid</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span> <span class="o">=</span> <span class="n">grid</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_grid_tests</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="Test.run_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_script">[docs]</a> <span class="k">def</span> <span class="nf">run_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script_name</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s">'APPLICATION'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">and</span>
+ <span class="n">script_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">):</span>
+ <span class="n">script</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">[</span><span class="n">script_name</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">script</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s">"WARNING: scrip"</span>
+ <span class="s">"t not found: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="s">"----------- sta"</span>
+ <span class="s">"rt </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"Run script: </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="s">"----------- end"</span>
+ <span class="s">" </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="Test.run_all_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_all_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_all_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">initTime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s">'test_setup'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s">"=== STARTING TESTS"</span><span class="p">))</span> <span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
+ <span class="s">'BASES'</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_testbase_tests</span><span class="p">()</span>
+
+ <span class="c"># calculate total execution time</span>
+ <span class="n">totalTime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">initTime</span>
+ <span class="n">totalTime</span> <span class="o">-=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span><span class="o">=</span><span class="n">totalTime</span><span class="o">.</span><span class="n">microseconds</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"=== END TESTS"</span><span class="p">)),</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">totalTime</span><span class="p">)),</span>
+ <span class="mi">2</span><span class="p">,</span>
+ <span class="bp">False</span><span class="p">)</span>
+
+ <span class="c">#</span>
+ <span class="c"># Start the tests</span>
+ <span class="c">#</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s">'test_cleanup'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+
+ <span class="c"># evaluate results</span>
+ <span class="n">res_count</span> <span class="o">=</span> <span class="s">"</span><span class="si">%d</span><span class="s"> / </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span><span class="p">)</span>
+
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Tests Results: </span><span class="si">%(succeed)d</span><span class="s"> / </span><span class="si">%(total)d</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s">'succeed'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span> <span class="s">'total'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="p">}</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span><span class="p">:</span>
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcSuccess</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">res_out</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"</span><span class="si">%d</span><span class="s"> tests TIMEOUT</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">res_count</span> <span class="o">+=</span> <span class="s">" TO: </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"</span><span class="si">%d</span><span class="s"> tests not executed</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">res_count</span> <span class="o">+=</span> <span class="s">" NR: </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span>
+
+ <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span>
+ <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">KNOWNFAILURE_STATUS</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Status: </span><span class="si">%s</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">status</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span>
+
+ <span class="c">##</span>
+ <span class="c"># Write margin to show test results.</span></div>
+<div class="viewcode-block" id="Test.write_test_margin"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.write_test_margin">[docs]</a> <span class="k">def</span> <span class="nf">write_test_margin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tab</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">tab</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="s">""</span>
+ <span class="k">return</span> <span class="s">"| "</span> <span class="o">*</span> <span class="p">(</span><span class="n">tab</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">+</span> <span class="s">"+ "</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.xmlManager — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.xmlManager</h1><div class="highlight"><pre>
+<span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+<span class="c"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c">#</span>
+<span class="c"># This library is free software; you can redistribute it and/or</span>
+<span class="c"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c"># License as published by the Free Software Foundation; either</span>
+<span class="c"># version 2.1 of the License.</span>
+<span class="c">#</span>
+<span class="c"># This library is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c"># Lesser General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c"># License along with this library; if not, write to the Free Software</span>
+<span class="c"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="k">try</span><span class="p">:</span> <span class="c"># For python2</span>
+ <span class="kn">import</span> <span class="nn">sys</span>
+ <span class="nb">reload</span><span class="p">(</span><span class="n">sys</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">setdefaultencoding</span><span class="p">(</span><span class="s">'utf8'</span><span class="p">)</span>
+<span class="k">except</span><span class="p">:</span>
+ <span class="k">pass</span>
+
+<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">ElementTree</span> <span class="k">as</span> <span class="n">etree</span>
+
+<div class="viewcode-block" id="XmlLogFile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile">[docs]</a><span class="k">class</span> <span class="nc">XmlLogFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">'''Class to manage writing in salomeTools xml log file</span>
+<span class="sd"> '''</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">rootname</span><span class="p">,</span> <span class="n">attrib</span> <span class="o">=</span> <span class="p">{}):</span>
+ <span class="sd">'''Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param filePath str: The path to the file where to write the log file</span>
+<span class="sd"> :param rootname str: The name of the root node of the xml file</span>
+<span class="sd"> :param attrib dict: the dictionary that contains the attributes </span>
+<span class="sd"> and value of the root node</span>
+<span class="sd"> '''</span>
+ <span class="c"># Initialize the filePath and ensure that the directory </span>
+ <span class="c"># that contain the file exists (make it if necessary)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logFile</span> <span class="o">=</span> <span class="n">filePath</span>
+ <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filePath</span><span class="p">))</span>
+ <span class="c"># Initialize the field that contain the xml in memory</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="n">rootname</span><span class="p">,</span> <span class="n">attrib</span> <span class="o">=</span> <span class="n">attrib</span><span class="p">)</span>
+
+<div class="viewcode-block" id="XmlLogFile.write_tree"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile.write_tree">[docs]</a> <span class="k">def</span> <span class="nf">write_tree</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stylesheet</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">file_path</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">'''Write the xml tree in the log file path. Add the stylesheet if asked.</span>
+<span class="sd"> </span>
+<span class="sd"> :param stylesheet str: The stylesheet to apply to the xml file</span>
+<span class="sd"> '''</span>
+ <span class="n">log_file_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">logFile</span>
+ <span class="k">if</span> <span class="n">file_path</span><span class="p">:</span>
+ <span class="n">log_file_path</span> <span class="o">=</span> <span class="n">file_path</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">log_file_path</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?xml version='1.0' encoding='utf-8'?></span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">stylesheet</span><span class="p">:</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?xml-stylesheet type='text/xsl' href='</span><span class="si">%s</span><span class="s">'?></span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span>
+ <span class="n">stylesheet</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">etree</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">'utf-8'</span><span class="p">))</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ </div>
+<div class="viewcode-block" id="XmlLogFile.add_simple_node"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile.add_simple_node">[docs]</a> <span class="k">def</span> <span class="nf">add_simple_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node_name</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{}):</span>
+ <span class="sd">'''Add a node with some attibutes and text to the root node.</span>
+<span class="sd"> </span>
+<span class="sd"> :param node_name str: the name of the node to add</span>
+<span class="sd"> :param text str: the text of the node</span>
+<span class="sd"> :param attrib dict: the dictionary containing the </span>
+<span class="sd"> attribute of the new node</span>
+<span class="sd"> '''</span>
+ <span class="n">n</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="n">node_name</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="n">attrib</span><span class="p">)</span>
+ <span class="n">n</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">n</span>
+ </div>
+<div class="viewcode-block" id="XmlLogFile.append_node_text"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_text">[docs]</a> <span class="k">def</span> <span class="nf">append_node_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node_name</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
+ <span class="sd">'''Append a new text to the node that has node_name as name</span>
+<span class="sd"> </span>
+<span class="sd"> :param node_name str: The name of the node on which append text</span>
+<span class="sd"> :param text str: The text to append</span>
+<span class="sd"> '''</span>
+ <span class="c"># find the corresponding node</span>
+ <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="n">node_name</span><span class="p">:</span>
+ <span class="c"># append the text</span>
+ <span class="n">field</span><span class="o">.</span><span class="n">text</span> <span class="o">+=</span> <span class="n">text</span>
+</div>
+<div class="viewcode-block" id="XmlLogFile.append_node_attrib"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_attrib">[docs]</a> <span class="k">def</span> <span class="nf">append_node_attrib</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node_name</span><span class="p">,</span> <span class="n">attrib</span><span class="p">):</span>
+ <span class="sd">'''Append a new attributes to the node that has node_name as name</span>
+<span class="sd"> </span>
+<span class="sd"> :param node_name str: The name of the node on which append text</span>
+<span class="sd"> :param attrib dixt: The attrib to append</span>
+<span class="sd"> '''</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">node_name</span><span class="p">)</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">attrib</span><span class="p">)</span>
+</div></div>
+<div class="viewcode-block" id="ReadXmlFile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.ReadXmlFile">[docs]</a><span class="k">class</span> <span class="nc">ReadXmlFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">'''Class to manage reading of an xml log file</span>
+<span class="sd"> '''</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filePath</span><span class="p">):</span>
+ <span class="sd">'''Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param filePath str: The xml file to be read</span>
+<span class="sd"> '''</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">filePath</span> <span class="o">=</span> <span class="n">filePath</span>
+ <span class="n">etree_inst</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">filePath</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span> <span class="o">=</span> <span class="n">etree_inst</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">filePath</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ReadXmlFile.getRootAttrib"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.ReadXmlFile.getRootAttrib">[docs]</a> <span class="k">def</span> <span class="nf">getRootAttrib</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''Get the attibutes of the self.xmlroot</span>
+<span class="sd"> </span>
+<span class="sd"> :return: The attributes of the root node</span>
+<span class="sd"> :rtype: dict</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">attrib</span>
+ </div>
+<div class="viewcode-block" id="ReadXmlFile.get_attrib"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_attrib">[docs]</a> <span class="k">def</span> <span class="nf">get_attrib</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node_name</span><span class="p">):</span>
+ <span class="sd">'''Get the attibutes of the node node_name in self.xmlroot</span>
+<span class="sd"> </span>
+<span class="sd"> :param node_name str: the name of the node</span>
+<span class="sd"> :return: the attibutes of the node node_name in self.xmlroot</span>
+<span class="sd"> :rtype: dict</span>
+<span class="sd"> '''</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">node_name</span><span class="p">)</span><span class="o">.</span><span class="n">attrib</span>
+ <span class="c"># To be python 3 compatible, convert bytes to str if there are any</span>
+ <span class="n">fixedAttrib</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">attrib</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="n">k</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="n">k</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">attrib</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="nb">bytes</span><span class="p">):</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">attrib</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">attrib</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
+ <span class="n">fixedAttrib</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+ <span class="k">return</span> <span class="n">fixedAttrib</span>
+ </div>
+<div class="viewcode-block" id="ReadXmlFile.get_node_text"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_node_text">[docs]</a> <span class="k">def</span> <span class="nf">get_node_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span>
+ <span class="sd">'''Get the text of the first node that has name </span>
+<span class="sd"> that corresponds to the parameter node</span>
+<span class="sd"> </span>
+<span class="sd"> :param node str: the name of the node from which get the text</span>
+<span class="sd"> :return: the text of the first node that has name </span>
+<span class="sd"> that corresponds to the parameter node</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">node</span><span class="p">)</span><span class="o">.</span><span class="n">text</span>
+ </div></div>
+<div class="viewcode-block" id="add_simple_node"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.add_simple_node">[docs]</a><span class="k">def</span> <span class="nf">add_simple_node</span><span class="p">(</span><span class="n">root_node</span><span class="p">,</span> <span class="n">node_name</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{}):</span>
+ <span class="sd">'''Add a node with some attibutes and text to the root node.</span>
+
+<span class="sd"> :param root_node etree.Element: the Etree element where to add the new node </span>
+<span class="sd"> :param node_name str: the name of the node to add</span>
+<span class="sd"> :param text str: the text of the node</span>
+<span class="sd"> :param attrib dict: the dictionary containing the </span>
+<span class="sd"> attribute of the new node</span>
+<span class="sd"> '''</span>
+ <span class="n">n</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="n">node_name</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="n">attrib</span><span class="p">)</span>
+ <span class="n">n</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="n">root_node</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">n</span>
+</div>
+<div class="viewcode-block" id="append_node_attrib"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.append_node_attrib">[docs]</a><span class="k">def</span> <span class="nf">append_node_attrib</span><span class="p">(</span><span class="n">root_node</span><span class="p">,</span> <span class="n">attrib</span><span class="p">):</span>
+ <span class="sd">'''Append a new attributes to the node that has node_name as name</span>
+<span class="sd"> </span>
+<span class="sd"> :param root_node etree.Element: the Etree element </span>
+<span class="sd"> where to append the new attibutes</span>
+<span class="sd"> :param attrib dixt: The attrib to append</span>
+<span class="sd"> '''</span>
+ <span class="n">root_node</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">attrib</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="find_node_by_attrib"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.find_node_by_attrib">[docs]</a><span class="k">def</span> <span class="nf">find_node_by_attrib</span><span class="p">(</span><span class="n">xmlroot</span><span class="p">,</span> <span class="n">name_node</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">'''Find the nfirst ode from xmlroot that has name name_node and that has in </span>
+<span class="sd"> its attributes {key : value}. Return the node</span>
+<span class="sd"> </span>
+<span class="sd"> :param xmlroot etree.Element: the Etree element where to search</span>
+<span class="sd"> :param name_node str: the name of node to search</span>
+<span class="sd"> :param key str: the key to search</span>
+<span class="sd"> :param value str: the value to search</span>
+<span class="sd"> :return: the found node</span>
+<span class="sd"> :rtype: xmlroot etree.Element</span>
+<span class="sd"> '''</span>
+ <span class="n">l_nodes</span> <span class="o">=</span> <span class="n">xmlroot</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">name_node</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">l_nodes</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">==</span> <span class="n">value</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">node</span>
+ <span class="k">return</span> <span class="bp">None</span>
+
+</div>
+<div class="viewcode-block" id="write_report"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.write_report">[docs]</a><span class="k">def</span> <span class="nf">write_report</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">xmlroot</span><span class="p">,</span> <span class="n">stylesheet</span><span class="p">):</span>
+ <span class="sd">"""Writes a report file from a XML tree.</span>
+<span class="sd"> </span>
+<span class="sd"> :param filename str: The path to the file to create</span>
+<span class="sd"> :param xmlroot etree.Element: the Etree element to write to the file</span>
+<span class="sd"> :param stylesheet str: The stylesheet to add to the begin of the file</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filename</span><span class="p">)):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span>
+
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?xml version='1.0' encoding='utf-8'?></span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">stylesheet</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"<?xml-stylesheet type='text/xsl' href='</span><span class="si">%s</span><span class="s">'?></span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> <span class="n">stylesheet</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">etree</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="n">xmlroot</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">'utf-8'</span><span class="p">))</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ </div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="../index.html">Module code</a><ul>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ src
--- /dev/null
+colorama Package
+================
+
+:mod:`colorama` Package
+-----------------------
+
+.. automodule:: src.colorama
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`ansi` Module
+------------------
+
+.. automodule:: src.colorama.ansi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`ansitowin32` Module
+-------------------------
+
+.. automodule:: src.colorama.ansitowin32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`initialise` Module
+------------------------
+
+.. automodule:: src.colorama.initialise
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`win32` Module
+-------------------
+
+.. automodule:: src.colorama.win32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`winterm` Module
+---------------------
+
+.. automodule:: src.colorama.winterm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
--- /dev/null
+src Package
+===========
+
+:mod:`src` Package
+------------------
+
+.. automodule:: src.__init__
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`ElementTree` Module
+-------------------------
+
+.. automodule:: src.ElementTree
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`architecture` Module
+--------------------------
+
+.. automodule:: src.architecture
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`compilation` Module
+-------------------------
+
+.. automodule:: src.compilation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`debug` Module
+-------------------
+
+.. automodule:: src.debug
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`environment` Module
+-------------------------
+
+.. automodule:: src.environment
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`fileEnviron` Module
+-------------------------
+
+.. automodule:: src.fileEnviron
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`fork` Module
+------------------
+
+.. automodule:: src.fork
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`logger` Module
+--------------------
+
+.. automodule:: src.logger
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`options` Module
+---------------------
+
+.. automodule:: src.options
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`printcolors` Module
+-------------------------
+
+.. automodule:: src.printcolors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`product` Module
+---------------------
+
+.. automodule:: src.product
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`pyconf` Module
+--------------------
+
+.. automodule:: src.pyconf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`system` Module
+--------------------
+
+.. automodule:: src.system
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`template` Module
+----------------------
+
+.. automodule:: src.template
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`test_module` Module
+-------------------------
+
+.. automodule:: src.test_module
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`xmlManager` Module
+------------------------
+
+.. automodule:: src.xmlManager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ src.colorama
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command application
+*********************
+
+Description
+===========
+The **application** command creates a virtual SALOME_ application.
+Virtual SALOME applications are used to start SALOME when distribution is needed.
+
+Usage
+=====
+* Create an application: ::
+
+ sat application <application>
+
+ Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``.
+
+* Give a name to the application: ::
+
+ sat application <application> --name <my_application_name>
+
+ *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``.
+
+* Change the directory where the application is created: ::
+
+ sat application <application> --target <my_application_directory>
+
+* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): ::
+
+ sat application <application> --catalog <path_to_catalog>
+
+ Note that the catalog specified will be copied to the application directory.
+
+* Generate the catalog for a list of machines: ::
+
+ sat application <application> --gencat machine1,machine2,machine3
+
+ This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
+
+* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+ sat launcher <application> --use_mesa
+
+Some useful configuration pathes
+=================================
+
+The virtual application can be configured with the virtual_app section of the configutation file.
+
+* **APPLICATION.virtual_app**
+
+ * **name** : name of the launcher (to replace the default runAppli).
+ * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``.
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command clean
+****************
+
+Description
+============
+
+The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``.
+
+Use the options to define what directories you want to suppress and to set the list of products
+
+
+Usage
+=======
+
+* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*):
+
+ .. code-block:: bash
+
+ # take care, is long time to restore, sometimes
+ sat clean SALOME-xx --build --install
+
+* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*:
+
+ .. code-block:: bash
+
+ sat clean SALOME-xxx --build --install \
+ --properties is_salome_module:yes
+
+
+Availables options
+======================
+
+ * **--products** : Products to clean.
+
+ * **--properties** :
+
+ | Filter the products by their properties.
+ | Syntax: *--properties <property>:<value>*
+
+ * **--sources** : Clean the product source directories.
+
+ * **--build** : Clean the product build directories.
+
+ * **--install** : Clean the product install directories.
+
+ * **--all** : Clean the product source, build and install directories.
+
+ * **--sources_without_dev** :
+
+ | Do not clean the products in development mode,
+ | (they could have VCS_ commits pending).
+
+
+
+Some useful configuration pathes
+=================================
+
+No specific configuration.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command compile
+****************
+
+Description
+===========
+The **compile** command allows compiling the products of a SALOME_ application.
+
+
+Usage
+=====
+* Compile a complete application: ::
+
+ sat compile <application>
+
+* Compile only some products: ::
+
+ sat compile <application> --products <product1>,<product2> ...
+
+* Use *sat -t* to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): ::
+
+ sat -t compile <application> --products <product1>
+
+* Compile a module and its dependencies: ::
+
+ sat compile <application> --products med --with_fathers
+
+* Compile a module and the modules depending on it (for example plugins): ::
+
+ sat compile <application> --products med --with_children
+
+* Clean the build and install directories before starting compilation: ::
+
+ sat compile <application> --products GEOM --clean_all
+
+ .. note:: | a warning will be shown if option *--products* is missing
+ | (as it will clean everything)
+
+* Clean only the install directories before starting compilation: ::
+
+ sat compile <application> --clean_install
+
+* Add options for make: ::
+
+ sat compile <application> --products <product> --make_flags <flags>
+
+* Use the *--check* option to execute the unit tests after compilation: ::
+
+ sat compile <application> --check
+
+* Remove the build directory after successful compilation (some build directory like qt are big): ::
+
+ sat compile <application> --products qt --clean_build_after
+
+* Stop the compilation as soon as the compilation of a module fails: ::
+
+ sat compile <product> --stop_first_fail
+
+* Do not compile, just show if products are installed or not, and where is the installation: ::
+
+ sat compile <application> --show
+
+
+Some useful configuration pathes
+=================================
+
+The way to compile a product is defined in the *pyconf file configuration*.
+The main options are:
+
+ * **build_source** : the method used to build the product (cmake/autotools/script)
+ * **compil_script** : the compilation script if build_source is equal to "script"
+ * **cmake_options** : additional options for cmake.
+ * **nb_proc** : number of jobs to use with make for this product.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command config
+******************
+
+Description
+===========
+The **config** command manages sat configuration.
+It allows display, manipulation and operation on configuration files
+
+Usage
+=====
+* Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: ::
+
+ sat config --edit
+
+* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: ::
+
+ sat config --list
+
+* Edit the configuration of an application: ::
+
+ sat config <application> --edit
+
+* Copy an application configuration file into the user personal directory: ::
+
+ sat config <application> --copy [new_name]
+
+* | Print the value of a configuration parameter.
+ | Use the automatic completion to get recursively the parameter names.
+ | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts).
+ | Examples (with *SALOME-xx* as *SALOME-8.4.0* ):
+
+ .. code-block:: bash
+
+ # sat config --value <parameter_path>
+ sat config --value . # all the configuration
+ sat config --value LOCAL
+ sat config --value LOCAL.workdir
+
+ # sat config <application> --value <parameter_path>
+ sat config SALOME-xx --value APPLICATION.workdir
+ sat config SALOME-xx --no_label --value APPLICATION.workdir
+
+* | Print in one-line-by-value mode the value of a configuration parameter,
+ | with its source *expression*, if any.
+ | This is a debug mode, useful for developers.
+ | Prints the parameter path, the source expression if any, and the final value:
+
+ ::
+
+ sat config SALOME-xx -g USER
+
+ .. note:: And so, *not only for fun*, to get **all expressions** of configuration
+
+ .. code-block:: bash
+
+ sat config SALOME-xx -g . | grep -e "-->"
+
+
+* Print the patches that are applied: ::
+
+ sat config SALOME-xx --show_patchs
+
+* Get information on a product configuration:
+
+ .. code-block:: bash
+
+ # sat config <application> --info <product>
+ sat config SALOME-xx --info KERNEL
+ sat config SALOME-xx --info qt
+
+Some useful configuration pathes
+=================================
+
+Exploring a current configuration.
+
+* **PATHS**: To get list of directories where to find files.
+
+* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir).
+
+sat commands: ::
+
+ sat config SALOME-xx -v PATHS
+ sat config SALOME-xx -v USERS
+
+
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command environ
+****************
+
+Description
+===========
+The **environ** command generates the environment files used
+to run and compile your application (as SALOME_ is an example).
+
+.. note ::
+ these files are **not** required,
+ salomeTool set the environment himself, when compiling.
+ And so does the salome launcher.
+
+ These files are useful when someone wants to check the environment.
+ They could be used in debug mode to set the environment for *gdb*.
+
+The configuration part at the end of this page explains how
+to specify the environment used by sat (at build or run time),
+and saved in some files by *sat environ* command.
+
+Usage
+=====
+* Create the shell environment files of the application: ::
+
+ sat environ <application>
+
+* Create the environment files of the application for a given shell.
+ Options are bash, bat (for windows) and cfg (the configuration format used by SALOME_): ::
+
+ sat environ <application> --shell [bash|cfg|all]
+
+* Use a different prefix for the files (default is 'env'):
+
+ .. code-block:: bash
+
+ # This will create file <prefix>_launch.sh, <prefix>_build.sh
+ sat environ <application> --prefix <prefix>
+
+* Use a different target directory for the files:
+
+ .. code-block:: bash
+
+ # This will create file env_launch.sh, env_build.sh
+ # in the directory corresponding to <path>
+ sat environ <application> --target <path>
+
+* Generate the environment files only with the given products:
+
+ .. code-block:: bash
+
+ # This will create the environment files only for the given products
+ # and their prerequisites.
+ # It is useful when you want to visualise which environment uses
+ # sat to compile a given product.
+ sat environ <application> --product <product1>,<product2>, ...
+
+
+Configuration
+=============
+
+The specification of the environment can be done through several mechanisms.
+
+1. For salome products (the products with the property ``is_SALOME_module`` as ``yes``) the environment is set automatically by sat, in respect with SALOME_ requirements.
+
+2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
+
+Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
+In the following example, we prepend *<install_dir>/lib* to ``LD_LIBRARY_PATH`` (note the *left first* underscore), append *<install_dir>/lib* to ``PYTHONPATH`` (note the *right last* underscore), and set ``LAPACK_ROOT_DIR`` to *<install_dir>*:
+
+.. code-block:: python
+
+ environ :
+ {
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ LAPACK_ROOT_DIR : $install_dir
+ }
+
+It is possible to distinguish the build environment from the launch environment: use a subsection called *build* or *launch*. In the example below, ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` are only modified at run time, not at compile time:
+
+.. code-block:: python
+
+ environ :
+ {
+ build :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ }
+ launch :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ }
+ }
+
+3. The last possibility is to set the environment with a python script. The script should be provided in the *products/env_scripts* directory of the sat project, and its name is specified in the environment section with the key ``environ.env_script``:
+
+.. code-block:: python
+
+ environ :
+ {
+ env_script : 'lapack.py'
+ }
+
+Please note that the two modes are complementary and are both taken into account.
+Most of the time, the first mode is sufficient.
+
+The second mode can be used when the environment has to be set programmatically.
+The developer implements a handle (as a python method)
+which is called by sat to set the environment.
+Here is an example:
+
+.. code-block:: python
+
+
+ #!/usr/bin/env python
+ #-*- coding:utf-8 -*-
+
+ import os.path
+ import platform
+
+ def set_env(env, prereq_dir, version):
+ env.set("TRUST_ROOT_DIR",prereq_dir)
+ env.prepend('PATH', os.path.join(prereq_dir, 'bin'))
+ env.prepend('PATH', os.path.join(prereq_dir, 'include'))
+ env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib'))
+ return
+
+SalomeTools defines four handles:
+
+* **set_env(env, prereq_dir, version)** : used at build and run time.
+* **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!)
+* **set_env_build(env, prereq_dir, version)** : used only at build time (if defined!)
+* **set_native_env(env)** : used only for native products, at build and run time.
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command generate
+****************
+
+Description
+===========
+The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN.
+
+.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``.
+
+
+Remarks
+=======
+* This command will only apply on the CPP modules of the application, those who have both properties: ::
+
+ cpp : "yes"
+ generate : "yes"
+
+* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
+
+
+Usage
+=====
+* Generate all the modules of a product: ::
+
+ sat generate <application>
+
+* Generate only specific modules: ::
+
+ sat generate <application> --products <list_of_products>
+
+ Remark: modules which don't have the *generate* property are ignored.
+
+* Use a specific version of YACSGEN: ::
+
+ sat generate <application> --yacsgen <path_to_yacsgen>
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command launcher
+******************
+
+Description
+===========
+The **launcher** command creates a SALOME launcher, a python script file to start SALOME_.
+
+
+Usage
+=====
+* Create a launcher: ::
+
+ sat launcher <application>
+
+ Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``.
+
+* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) ::
+
+ sat launcher <application> --name ZeLauncher
+
+ The launcher will be called *ZeLauncher*.
+
+* Set a specific resources catalog: ::
+
+ sat launcher <application> --catalog <path of a salome resources catalog>
+
+ Note that the catalog specified will be copied to the profile directory.
+
+* Generate the catalog for a list of machines: ::
+
+ sat launcher <application> --gencat <list of machines>
+
+ This will create a catalog by querying each machine (memory, number of processor) with ssh.
+
+* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+ sat launcher <application> --use_mesa
+
+
+Configuration
+=============
+
+Some useful configuration pathes:
+
+* **APPLICATION.profile**
+
+ * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
+ * **launcher_name** : the name of the launcher.
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command log
+****************
+
+Description
+===========
+The **log** command displays sat log in a web browser or in a terminal.
+
+Usage
+=====
+* Show (in a web browser) the log of the commands corresponding to an application: ::
+
+ sat log <application>
+
+* Show the log for commands that do not use any application: ::
+
+ sat log
+
+* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: ::
+
+ sat log <application> --terminal
+
+* The --last option displays only the last command: ::
+
+ sat log <application> --last
+
+* To access the last compilation log in terminal mode, use --last_terminal option: ::
+
+ sat log <application> --last_terminal
+
+* The --clean (int) option erases the n older log files and print the number of remaining log files: ::
+
+ sat log <application> --clean 50
+
+
+
+Some useful configuration pathes
+=================================
+
+* **USER**
+
+ * **browser** : The browser used to show the log (by default *firefox*).
+ * **log_dir** : The directory used to store the log files.
+
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command package
+****************
+
+Description
+============
+The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz).
+This tar file is used later to intall SALOME on other remote computer.
+
+Depending on the selected options, the archive includes sources and binaries
+of SALOME products and prerequisites.
+
+Usually utility *salomeTools* is included in the archive.
+
+.. note::
+ By default the package includes the sources of prerequisites and products.
+ To select a subset use the *--without_property* or *--with_vcs* options.
+
+
+Usage
+=====
+* Create a package for a product (example as *SALOME_xx*): ::
+
+ sat package SALOME_xx
+
+ This command will create an archive named ``SALOME_xx.tgz``
+ in the working directory (``USER.workDir``).
+ If the archive already exists, do nothing.
+
+
+* Create a package with a specific name: ::
+
+ sat package SALOME_xx --name YourSpecificName
+
+.. note::
+ By default, the archive is created in the working directory of the user (``USER.workDir``).
+
+ If the option *--name* is used with a path (relative or absolute) it will be used.
+
+ If the option *--name* is not used and binaries (prerequisites and products)
+ are included in the package, the OS_ architecture
+ will be appended to the name (example: ``SALOME_xx-CO7.tgz``).
+
+ Examples: ::
+
+ # Creates SALOME_xx.tgz in $USER.workDir
+ sat package SALOME_xx
+
+ # Creates SALOME_xx_<arch>.tgz in $USER.workDir
+ sat package SALOME_xx --binaries
+
+ # Creates MySpecificName.tgz in $USER.workDir
+ sat package SALOME_xx --name MySpecificName
+
+
+* Force the creation of the archive (if it already exists): ::
+
+ sat package SALOME_xx --force
+
+
+* Include the binaries in the archive (products and prerequisites): ::
+
+ sat package SALOME_xx --binaries
+
+ This command will create an archive named ``SALOME_xx _<arch>.tgz``
+ where <arch> is the OS_ architecture of the machine.
+
+
+* Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: ::
+
+ sat package SALOME_xx --with_vcs
+
+ The version control systems known by this option are CVS_, SVN_ and Git_.
+
+
+Some useful configuration pathes
+=================================
+
+No specific configuration.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command prepare
+****************
+
+Description
+===========
+The **prepare** command brings the sources of an application in the *sources
+application directory*, in order to compile them with the compile command.
+
+The sources can be prepared from VCS software (*cvs, svn, git*), an archive or a directory.
+
+.. warning:: When sat prepares a product, it first removes the
+ existing directory, except if the development mode is activated.
+ When you are working on a product, you need to declare in
+ the application configuration this product in **dev** mode.
+
+Remarks
+=======
+
+VCS bases (git, svn, cvs)
+-------------------------
+
+The *prepare* command does not manage authentication on the cvs server.
+For example, to prepare modules from a cvs server, you first need to login once.
+
+To avoid typing a password for each product,
+you may use a ssh key with passphrase, or store your password
+(in .cvspass or .gitconfig files).
+If you have security concerns, it is also possible to use
+a bash agent and type your password only once.
+
+
+
+Dev mode
+--------
+
+By default *prepare* uses *export* mode: it creates an image
+of the sources, corresponding to the tag or branch specified,
+without any link to the VCS base.
+To perform a *checkout* (svn, cvs) or a *git clone* (git),
+you need to declare the product in dev mode in your application configuration:
+edit the application configuration file (pyconf) and modify the product declaration:
+
+.. code-block:: bash
+
+ sat config <application> -e
+ # and edit the product section:
+ # <product> : {tag : "my_tag", dev : "yes", debug : "yes"}
+
+The first time you will execute the *sat prepare* command,
+your module will be downloaded in *checkout* mode
+(inside the SOURCES directory of the application.
+Then, you can develop in this repository, and finally push
+them in the base when they are ready.
+If you type during the development process by mistake
+a *sat prepare* command, the sources in dev mode will
+not be altered/removed (Unless you use -f option)
+
+
+Usage
+=====
+* Prepare the sources of a complete application in SOURCES directory (all products): ::
+
+ sat prepare <application>
+
+* Prepare only some modules: ::
+
+ sat prepare <application> --products <product1>,<product2> ...
+
+* Use --force to force to prepare the products in development mode
+ (this will remove the sources and do a new clone/checkout): ::
+
+ sat prepare <application> --force
+
+* Use --force_patch to force to apply patch to the products
+ in development mode (otherwise they are not applied): ::
+
+ sat prepare <application> --force_patch
+
+
+Some useful configuration pathes
+=================================
+
+Command *sat prepare* uses the *pyconf file configuration* of each product to know how to get the sources.
+
+.. note:: to verify configuration of a product, and get name of this *pyconf files configuration*
+
+ .. code-block :: bash
+
+ sat config <application> --info <product>
+
+
+* **get_method**: the method to use to prepare the module, possible values are cvs, git, archive, dir.
+* **git_info** : (used if get_method = git) information to prepare sources from git.
+* **svn_info** : (used if get_method = svn) information to prepare sources from cvs.
+* **cvs_info** : (used if get_method = cvs) information to prepare sources from cvs.
+* **archive_info** : (used if get_method = archive) the path to the archive.
+* **dir_info** : (used if get_method = dir) the directory with the sources.
--- /dev/null
+*************
+Configuration
+*************
+
+*salomeTools* uses files to store its configuration parameters.
+
+There are several configuration files which are loaded by salomeTools in a specific order.
+When all the files are loaded a *config* object is created.
+Then, this object is passed to all command scripts.
+
+
+Syntax
+======
+The configuration files use a python-like structure format
+(see `config module <http://www.red-dove.com/config-doc/>`_ for a complete description).
+
+* **{}** define a dictionary,
+* **[]** define a list,
+* **@** can be used to include a file,
+* **$prefix** reference to another parameter (ex: ``$PRODUCT.name``),
+* **#** comments.
+
+.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``.
+
+Description
+===========
+
+.. _VARS-Section:
+
+VARS section
+-------------
+| This section is dynamically created by salomeTools at run time.
+| It contains information about the environment: date, time, OS, architecture etc.
+
+::
+
+ # to get the current setting
+ sat config --value VARS
+
+PRODUCTS section
+------------------
+| This section is defined in the product file.
+| It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value PRODUCTS
+
+APPLICATION section
+---------------------
+| This section is optional, it is also defined in the product file.
+| It gives additional parameters to create an application based on SALOME, as versions of products to use.
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value APPLICATION
+
+
+.. _USER-Section:
+
+USER section
+--------------
+This section is defined by the user configuration file,
+``~/.salomeTools/salomeTools.pyconf``.
+
+The ``USER`` section defines some parameters (not exhaustive):
+
+* **workDir** :
+
+ | The working directory.
+ | Each product will be usually installed here (in sub-directories).
+
+* **browser** : The web browser to use (*firefox*).
+
+* **editor** : The editor to use (*vi, pluma*).
+
+* and other user preferences.
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value USER
+
+
+
+
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+************
+Salome Tools
+************
+
+.. image:: images/sat_about.png
+ :scale: 100 %
+ :align: center
+
+.. warning:: This documentation is under construction.
+
+The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands
+that can be used to perform operations on SALOME_.
+
+For example, sat allows you to compile SALOME's codes
+(prerequisites, products)
+create application, run tests, create package, etc.
+
+This utility code is a set of Python_ scripts files.
+
+
+Quick start
+===========
+
+.. toctree::
+ :maxdepth: 1
+
+ Installation of salomeTools <installation_of_sat>
+ Configuration <configuration>
+ Usage of salomeTools <usage_of_sat>
+
+List of Commands
+================
+
+.. toctree::
+ :maxdepth: 1
+
+ config <commands/config>
+ prepare <commands/prepare>
+ compile <commands/compile>
+ launcher <commands/launcher>
+ application <commands/application>
+ log <commands/log>
+ environ <commands/environ>
+ clean <commands/clean>
+ package <commands/package>
+ generate <commands/generate>
+
+Developer documentation
+=======================
+
+.. toctree::
+ :maxdepth: 1
+
+ Add a command <write_command>
+
+
+Code documentation
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ SAT modules <commands/apidoc/modules.rst>
+
+
+Release Notes
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ Release Notes 5.0.0 <release_notes/release_notes_5.0.0>
+
--- /dev/null
+************
+Installation
+************
+
+Usually user could find (and use) command **sat** directly after a 'detar' installation of SALOME.
+
+.. code-block:: bash
+
+ tar -xf .../SALOME_xx.tgz
+ cd SALOME_xx
+ ls -l sat # sat -> salomeTools/sat
+
+
+Python package (scripts of salomeTools) actually remains in directory *salomeTools*.
+
--- /dev/null
+***************
+Release notes
+***************
+
+In construction.
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+********************
+Usage of SAlomeTools
+********************
+
+Usage
+=====
+sat usage is a Command Line Interface (CLI_).
+
+.. code-block:: bash
+
+ sat [generic_options] [command] [product] [command_options]
+
+Options of sat
+--------------
+
+Useful *not exhaustive* generic options of *sat* CLI.
+
+*--help or -h*
+...............
+
+Get help as simple text.
+
+.. code-block:: bash
+
+ sat --help # get the list of existing commands
+ sat --help compile # get the help on a specific command 'compile'
+
+
+*--debug or -g*
+................
+
+Execution in debug mode allows to see more trace and *stack* if an exception is raised.
+
+*--verbose or -v*
+..................
+
+Change verbosity level (default is 3).
+
+.. code-block:: bash
+
+ # for product 'SALOME_xx' for example
+ # execute compile command in debug mode with trace level 4
+ sat -g -v 4 compile SALOME_xx
+
+
+Build a SALOME product
+======================
+
+Get the list of available products
+----------------------------------
+
+To get the list of the current available products in your context:
+
+.. code-block:: bash
+
+ sat config --list
+
+Prepare sources of a product
+----------------------------
+
+To prepare (get) *all* the sources of a product (*SALOME_xx* for example):
+
+.. code-block:: bash
+
+ sat prepare SALOME_xx
+
+| The sources are usually copied in directories
+| *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name*
+
+
+Compile SALOME
+----------------
+
+To compile products:
+
+.. code-block:: bash
+
+ # compile all prerequisites/products
+ sat compile SALOME_xx
+
+ # compile only 2 products (KERNEL and SAMPLES), if not done yet
+ sat compile SALOME_xx --products KERNEL,SAMPLES
+
+ # compile only 2 products, unconditionaly
+ sat compile SALOME_xx ---products SAMPLES --clean_all
+
+
+| The products are usually build in the directories
+| *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name*
+|
+| The products are usually installed in the directories
+| *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name*
+
+
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+
+Add a user custom command
+***************************
+
+Introduction
+============
+
+.. note:: This documentation is for Python_ developers.
+
+
+The salomeTools product provides a simple way to develop commands.
+The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools.
+
+Here are the basic requirements that must be followed in this file in order to add a command.
+
+Basic requirements
+==================
+
+By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``.
+
+In *mycommand.py*, there must be the following method: ::
+
+ def run(args, runner, logger):
+ # your algorithm ...
+ pass
+
+In fact, at this point, the command will already be functional.
+But there are some useful services provided by salomeTools :
+
+* You can give some options to your command:
+
+.. code-block:: python
+
+ import src
+
+ # Define all possible option for mycommand command : 'sat mycommand <options>'
+ parser = src.options.Options()
+ parser.add_option('m', 'myoption', \
+ 'boolean', 'myoption', \
+ 'My option changes the behavior of my command.')
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+
+
+* You can add a *description* method that will display a message when the user will call the help:
+
+
+.. code-block:: python
+ :emphasize-lines: 9,10
+
+ import src
+
+ # Define all possible option for mycommand command : 'sat mycommand <options>'
+ parser = src.options.Options()
+ parser.add_option('m', 'myoption', \
+ 'boolean', 'myoption', \
+ 'My option changes the behavior of my command.')
+
+ def description():
+ return _("The help of mycommand.")
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+
+HowTo access salomeTools config and other commands
+========================================================
+
+The *runner* variable is an python instance of *Sat* class.
+It gives access to *runner.cfg* which is the data model defined from all
+*configuration pyconf files* of salomeTools
+For example, *runner.cfg.APPLICATION.workdir*
+contains the root directory of the current application.
+
+The *runner* variable gives also access to other commands of salomeTools:
+
+.. code-block:: python
+
+ # as CLI_ 'sat prepare ...'
+ runner.prepare(runner.cfg.VARS.application)
+
+HowTo logger
+==============
+
+The logger variable is an instance of the Logger class.
+It gives access to the write method.
+
+When this method is called, the message passed as parameter
+will be displayed in the terminal and written in an xml log file.
+
+.. code-block:: python
+
+ logger.write("My message", 3) # 3 as default
+
+The second argument defines the level of verbosity
+that is wanted for this message.
+It has to be between 1 and 5 (the most verbose level).
+
+HELLO example
+==============
+
+Here is a *hello* command, file *commands/hello.py*:
+
+.. code-block:: python
+
+ import src
+
+ """
+ hello.py
+ Define all possible options for hello command:
+ sat hello <options>
+ """
+
+ parser = src.options.Options()
+ parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.")
+
+ def description():
+ return _("The help of hello.")
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+ if not options.french:
+ logger.write('HELLO! WORLD!\n')
+ else:
+ logger.write('Bonjour tout le monde!\n')
+
+A first call of hello:
+
+.. code-block:: bash
+
+ # Get the help of hello:
+ ./sat --help hello
+
+ # To get bonjour
+ ./sat hello --french
+ Bonjour tout le monde!
+
+ # To get hello
+ ./sat hello
+ HELLO! WORLD!
+
+ # To get the log
+ ./sat log
+
+
+
+
+
--- /dev/null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
+ font-size: 0.9em;
+ background-color: #fff;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+
+div.document {
+ width: 1000px;
+ margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 250px;
+}
+
+div.sphinxsidebar {
+ width: 250px;
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+hr {
+ border: 1px solid #B1B4B6;
+}
+
+div.body {
+ background-color: #fff;
+ color: #3E4349;
+ padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+ text-align: left;
+}
+
+div.footer {
+ width: 1000px;
+ margin: 20px auto 30px auto;
+ font-size: 14px;
+ color: #888;
+ text-align: right;
+}
+
+div.footer a {
+ color: #888;
+}
+
+p.caption {
+ font-family: inherit;
+ font-size: inherit;
+}
+
+
+
+div.sphinxsidebar a {
+ color: #444;
+ text-decoration: none;
+ border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+ border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 0;
+ margin: -10px 0 0 0px;
+ text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+ margin-top: -10px;
+ text-align: center;
+ margin-bottom: 5px;
+ text-align: left;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+ margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+ margin-top: 0;
+ font-style: normal;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: 'Garamond', 'Georgia', serif;
+ color: #444;
+ font-size: 24px;
+ font-weight: normal;
+ margin: 0 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+ border: none;
+}
+
+div.sphinxsidebar p {
+ color: #555;
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: #000;
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+ font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+ font-size: 110%;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #CCC;
+ font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar hr {
+ border: none;
+ height: 1px;
+ color: #AAA;
+ background: #AAA;
+
+ text-align: left;
+ margin-left: 0;
+ width: 50%;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #004B6B;
+ text-decoration: underline;
+}
+
+a:hover {
+ color: #6D4100;
+ text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Garamond', 'Georgia', serif;
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #DDD;
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: #444;
+ background: #EAEAEA;
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ margin: 20px 0px;
+ padding: 10px 30px;
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fafafa;
+}
+
+div.admonition p.admonition-title {
+ font-family: 'Garamond', 'Georgia', serif;
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight {
+ background-color: #fff;
+}
+
+dt:target, .highlight {
+ background: #FAF3E8;
+}
+
+div.warning {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.danger {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.attention {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.important {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.note {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.tip {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.hint {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.seealso {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.topic {
+ background-color: #EEE;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt, code {
+ font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.8em;
+}
+
+.hll {
+ background-color: #FFC;
+ margin: 0 -12px;
+ padding: 0 12px;
+ display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils {
+ border: 1px solid #888;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid #888;
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid #EEE;
+ background: #FDFDFD;
+ font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+ margin-top: -15px;
+ border-top: none;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+table.footnote td.label {
+ width: .1px;
+ padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+ padding: 0.3em 0.5em;
+}
+
+dl {
+ margin: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
+}
+
+blockquote {
+ margin: 0 0 0 30px;
+ padding: 0;
+}
+
+ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
+ margin: 10px 0 10px 30px;
+ padding: 0;
+}
+
+pre {
+ background: #fee;
+ padding: 7px 30px;
+ margin: 15px 0px;
+ line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+ background: #ffd;
+}
+
+dl pre, blockquote pre, li pre {
+ margin-left: 0;
+ padding-left: 30px;
+}
+
+tt, code {
+ background-color: #ecf0f3;
+ color: #222;
+ /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fff;
+}
+
+a.reference {
+ text-decoration: none;
+ border-bottom: 1px dotted #004B6B;
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+ text-decoration: none;
+ font-size: 0.7em;
+ vertical-align: top;
+ border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt, a:hover code {
+ background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+ div.sphinxsidebar {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+
+ }
+
+ div.documentwrapper {
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ }
+
+ div.bodywrapper {
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ margin-left: 0;
+ }
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .bodywrapper {
+ margin: 0;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+ body {
+ margin: 0;
+ padding: 20px 30px;
+ }
+
+ div.documentwrapper {
+ float: none;
+ background: #fff;
+ }
+
+ div.sphinxsidebar {
+ display: block;
+ float: none;
+ width: 102.5%;
+ margin: 50px -30px -20px -30px;
+ padding: 10px 20px;
+ background: #333;
+ color: #FFF;
+ }
+
+ div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+ div.sphinxsidebar h3 a {
+ color: #fff;
+ }
+
+ div.sphinxsidebar a {
+ color: #AAA;
+ }
+
+ div.sphinxsidebar p.logo {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+ margin: 0;
+ }
+
+ div.footer {
+ display: none;
+ }
+
+ div.bodywrapper {
+ margin: 0;
+ }
+
+ div.body {
+ min-height: 0;
+ padding: 0;
+ }
+
+ .rtd_doc_footer {
+ display: none;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+}
+
+
+/* misc. */
+
+.revsys-inline {
+ display: none!important;
+}
+
+/* Make nested-list/multi-paragraph items look better in Releases changelog
+ * pages. Without this, docutils' magical list fuckery causes inconsistent
+ * formatting between different release sub-lists.
+ */
+div#changelog > div.section > ul > li > p:only-child {
+ margin-bottom: 0;
+}
+
+/* Hide fugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+ border: none;
+ /* Below needed in some edge cases; if not applied, bottom shadows appear */
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
\ No newline at end of file
--- /dev/null
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ width: 170px;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ width: 30px;
+}
+
+img {
+ border: 0;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li div.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.field-list ul {
+ padding-left: 1em;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px 7px 0 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px 7px 0 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+div.admonition dl {
+ margin-bottom: 0;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd p {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dt:target, .highlighted {
+ background-color: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.refcount {
+ color: #060;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+td.linenos pre {
+ padding: 5px 0px;
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ margin-left: 0.5em;
+}
+
+table.highlighttable td {
+ padding: 0 0.5em 0 0.5em;
+}
+
+tt.descname {
+ background-color: transparent;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+
+tt.descclassname {
+ background-color: transparent;
+}
+
+tt.xref, a tt {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
--- /dev/null
+/* This file intentionally left blank. */
+
--- /dev/null
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for all documentation.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+/**
+ * make the code below compatible with browsers without
+ * an installed firebug like debugger
+if (!window.console || !console.firebug) {
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
+ "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
+ "profile", "profileEnd"];
+ window.console = {};
+ for (var i = 0; i < names.length; ++i)
+ window.console[names[i]] = function() {};
+}
+ */
+
+/**
+ * small helper function to urldecode strings
+ */
+jQuery.urldecode = function(x) {
+ return decodeURIComponent(x).replace(/\+/g, ' ');
+}
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s == 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * small function to check if an array contains
+ * a given item.
+ */
+jQuery.contains = function(arr, item) {
+ for (var i = 0; i < arr.length; i++) {
+ if (arr[i] == item)
+ return true;
+ }
+ return false;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node) {
+ if (node.nodeType == 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+ var span = document.createElement("span");
+ span.className = className;
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this);
+ });
+ }
+ }
+ return this.each(function() {
+ highlight(this);
+ });
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+var Documentation = {
+
+ init : function() {
+ this.fixFirefoxAnchorBug();
+ this.highlightSearchWords();
+ this.initIndexTable();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS : {},
+ PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
+ LOCALE : 'unknown',
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext : function(string) {
+ var translated = Documentation.TRANSLATIONS[string];
+ if (typeof translated == 'undefined')
+ return string;
+ return (typeof translated == 'string') ? translated : translated[0];
+ },
+
+ ngettext : function(singular, plural, n) {
+ var translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated == 'undefined')
+ return (n == 1) ? singular : plural;
+ return translated[Documentation.PLURALEXPR(n)];
+ },
+
+ addTranslations : function(catalog) {
+ for (var key in catalog.messages)
+ this.TRANSLATIONS[key] = catalog.messages[key];
+ this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
+ this.LOCALE = catalog.locale;
+ },
+
+ /**
+ * add context elements like header anchor links
+ */
+ addContextElements : function() {
+ $('div[id] > :header:first').each(function() {
+ $('<a class="headerlink">\u00B6</a>').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this headline')).
+ appendTo(this);
+ });
+ $('dt[id]').each(function() {
+ $('<a class="headerlink">\u00B6</a>').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this definition')).
+ appendTo(this);
+ });
+ },
+
+ /**
+ * workaround a firefox stupidity
+ */
+ fixFirefoxAnchorBug : function() {
+ if (document.location.hash && $.browser.mozilla)
+ window.setTimeout(function() {
+ document.location.href += '';
+ }, 10);
+ },
+
+ /**
+ * highlight the search words provided in the url in the text
+ */
+ highlightSearchWords : function() {
+ var params = $.getQueryParameters();
+ var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
+ if (terms.length) {
+ var body = $('div.body');
+ window.setTimeout(function() {
+ $.each(terms, function() {
+ body.highlightText(this.toLowerCase(), 'highlighted');
+ });
+ }, 10);
+ $('<p class="highlight-link"><a href="javascript:Documentation.' +
+ 'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
+ .appendTo($('#searchbox'));
+ }
+ },
+
+ /**
+ * init the domain index toggle buttons
+ */
+ initIndexTable : function() {
+ var togglers = $('img.toggler').click(function() {
+ var src = $(this).attr('src');
+ var idnum = $(this).attr('id').substr(7);
+ $('tr.cg-' + idnum).toggle();
+ if (src.substr(-9) == 'minus.png')
+ $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
+ else
+ $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
+ }).css('display', '');
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
+ togglers.click();
+ }
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords : function() {
+ $('#searchbox .highlight-link').fadeOut(300);
+ $('span.highlighted').removeClass('highlighted');
+ },
+
+ /**
+ * make the url absolute
+ */
+ makeURL : function(relativeURL) {
+ return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
+ },
+
+ /**
+ * get the current relative url
+ */
+ getCurrentURL : function() {
+ var path = document.location.pathname;
+ var parts = path.split(/\//);
+ $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
+ if (this == '..')
+ parts.pop();
+ });
+ var url = parts.join('/');
+ return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ }
+};
+
+// quick alias for translations
+_ = Documentation.gettext;
+
+$(document).ready(function() {
+ Documentation.init();
+});
--- /dev/null
+/*!
+ * jQuery JavaScript Library v1.4.2
+ * http://jquery.com/
+ *
+ * Copyright 2010, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ * Copyright 2010, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ *
+ * Date: Sat Feb 13 22:33:48 2010 -0500
+ */
+(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o<i;o++)e(a[o],b,f?d.call(a[o],o,e(a[o],b)):d,j);return a}return i?
+e(a[0],b):w}function J(){return(new Date).getTime()}function Y(){return false}function Z(){return true}function na(a,b,d){d[0].type=a;return c.event.handle.apply(b,d)}function oa(a){var b,d=[],f=[],e=arguments,j,i,o,k,n,r;i=c.data(this,"events");if(!(a.liveFired===this||!i||!i.live||a.button&&a.type==="click")){a.liveFired=this;var u=i.live.slice(0);for(k=0;k<u.length;k++){i=u[k];i.origType.replace(O,"")===a.type?f.push(i.selector):u.splice(k--,1)}j=c(a.target).closest(f,a.currentTarget);n=0;for(r=
+j.length;n<r;n++)for(k=0;k<u.length;k++){i=u[k];if(j[n].selector===i.selector){o=j[n].elem;f=null;if(i.preType==="mouseenter"||i.preType==="mouseleave")f=c(a.relatedTarget).closest(i.selector)[0];if(!f||f!==o)d.push({elem:o,handleObj:i})}}n=0;for(r=d.length;n<r;n++){j=d[n];a.currentTarget=j.elem;a.data=j.handleObj.data;a.handleObj=j.handleObj;if(j.handleObj.origHandler.apply(j.elem,e)===false){b=false;break}}return b}}function pa(a,b){return"live."+(a&&a!=="*"?a+".":"")+b.replace(/\./g,"`").replace(/ /g,
+"&")}function qa(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function ra(a,b){var d=0;b.each(function(){if(this.nodeName===(a[d]&&a[d].nodeName)){var f=c.data(a[d++]),e=c.data(this,f);if(f=f&&f.events){delete e.handle;e.events={};for(var j in f)for(var i in f[j])c.event.add(this,j,f[j][i],f[j][i].data)}}})}function sa(a,b,d){var f,e,j;b=b&&b[0]?b[0].ownerDocument||b[0]:s;if(a.length===1&&typeof a[0]==="string"&&a[0].length<512&&b===s&&!ta.test(a[0])&&(c.support.checkClone||!ua.test(a[0]))){e=
+true;if(j=c.fragments[a[0]])if(j!==1)f=j}if(!f){f=b.createDocumentFragment();c.clean(a,b,f,d)}if(e)c.fragments[a[0]]=j?f:1;return{fragment:f,cacheable:e}}function K(a,b){var d={};c.each(va.concat.apply([],va.slice(0,b)),function(){d[this]=a});return d}function wa(a){return"scrollTo"in a&&a.document?a:a.nodeType===9?a.defaultView||a.parentWindow:false}var c=function(a,b){return new c.fn.init(a,b)},Ra=A.jQuery,Sa=A.$,s=A.document,T,Ta=/^[^<]*(<[\w\W]+>)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/,
+Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&&
+(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this,
+a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b===
+"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this,
+function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b<d;b++)if((e=arguments[b])!=null)for(j in e){i=a[j];o=e[j];if(a!==o)if(f&&o&&(c.isPlainObject(o)||c.isArray(o))){i=i&&(c.isPlainObject(i)||
+c.isArray(i))?i:c.isArray(o)?[]:{};a[j]=c.extend(f,i,o)}else if(o!==w)a[j]=o}return a};c.extend({noConflict:function(a){A.$=Sa;if(a)A.jQuery=Ra;return c},isReady:false,ready:function(){if(!c.isReady){if(!s.body)return setTimeout(c.ready,13);c.isReady=true;if(Q){for(var a,b=0;a=Q[b++];)a.call(s,c);Q=null}c.fn.triggerHandler&&c(s).triggerHandler("ready")}},bindReady:function(){if(!xa){xa=true;if(s.readyState==="complete")return c.ready();if(s.addEventListener){s.addEventListener("DOMContentLoaded",
+L,false);A.addEventListener("load",c.ready,false)}else if(s.attachEvent){s.attachEvent("onreadystatechange",L);A.attachEvent("onload",c.ready);var a=false;try{a=A.frameElement==null}catch(b){}s.documentElement.doScroll&&a&&ma()}}},isFunction:function(a){return $.call(a)==="[object Function]"},isArray:function(a){return $.call(a)==="[object Array]"},isPlainObject:function(a){if(!a||$.call(a)!=="[object Object]"||a.nodeType||a.setInterval)return false;if(a.constructor&&!aa.call(a,"constructor")&&!aa.call(a.constructor.prototype,
+"isPrototypeOf"))return false;var b;for(b in a);return b===w||aa.call(a,b)},isEmptyObject:function(a){for(var b in a)return false;return true},error:function(a){throw a;},parseJSON:function(a){if(typeof a!=="string"||!a)return null;a=c.trim(a);if(/^[\],:{}\s]*$/.test(a.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,"@").replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,"]").replace(/(?:^|:|,)(?:\s*\[)+/g,"")))return A.JSON&&A.JSON.parse?A.JSON.parse(a):(new Function("return "+
+a))();else c.error("Invalid JSON: "+a)},noop:function(){},globalEval:function(a){if(a&&Va.test(a)){var b=s.getElementsByTagName("head")[0]||s.documentElement,d=s.createElement("script");d.type="text/javascript";if(c.support.scriptEval)d.appendChild(s.createTextNode(a));else d.text=a;b.insertBefore(d,b.firstChild);b.removeChild(d)}},nodeName:function(a,b){return a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,b,d){var f,e=0,j=a.length,i=j===w||c.isFunction(a);if(d)if(i)for(f in a){if(b.apply(a[f],
+d)===false)break}else for(;e<j;){if(b.apply(a[e++],d)===false)break}else if(i)for(f in a){if(b.call(a[f],f,a[f])===false)break}else for(d=a[0];e<j&&b.call(d,e,d)!==false;d=a[++e]);return a},trim:function(a){return(a||"").replace(Wa,"")},makeArray:function(a,b){b=b||[];if(a!=null)a.length==null||typeof a==="string"||c.isFunction(a)||typeof a!=="function"&&a.setInterval?ba.call(b,a):c.merge(b,a);return b},inArray:function(a,b){if(b.indexOf)return b.indexOf(a);for(var d=0,f=b.length;d<f;d++)if(b[d]===
+a)return d;return-1},merge:function(a,b){var d=a.length,f=0;if(typeof b.length==="number")for(var e=b.length;f<e;f++)a[d++]=b[f];else for(;b[f]!==w;)a[d++]=b[f++];a.length=d;return a},grep:function(a,b,d){for(var f=[],e=0,j=a.length;e<j;e++)!d!==!b(a[e],e)&&f.push(a[e]);return f},map:function(a,b,d){for(var f=[],e,j=0,i=a.length;j<i;j++){e=b(a[j],j,d);if(e!=null)f[f.length]=e}return f.concat.apply([],f)},guid:1,proxy:function(a,b,d){if(arguments.length===2)if(typeof b==="string"){d=a;a=d[b];b=w}else if(b&&
+!c.isFunction(b)){d=b;b=w}if(!b&&a)b=function(){return a.apply(d||this,arguments)};if(a)b.guid=a.guid=a.guid||b.guid||c.guid++;return b},uaMatch:function(a){a=a.toLowerCase();a=/(webkit)[ \/]([\w.]+)/.exec(a)||/(opera)(?:.*version)?[ \/]([\w.]+)/.exec(a)||/(msie) ([\w.]+)/.exec(a)||!/compatible/.test(a)&&/(mozilla)(?:.*? rv:([\w.]+))?/.exec(a)||[];return{browser:a[1]||"",version:a[2]||"0"}},browser:{}});P=c.uaMatch(P);if(P.browser){c.browser[P.browser]=true;c.browser.version=P.version}if(c.browser.webkit)c.browser.safari=
+true;if(ya)c.inArray=function(a,b){return ya.call(b,a)};T=c(s);if(s.addEventListener)L=function(){s.removeEventListener("DOMContentLoaded",L,false);c.ready()};else if(s.attachEvent)L=function(){if(s.readyState==="complete"){s.detachEvent("onreadystatechange",L);c.ready()}};(function(){c.support={};var a=s.documentElement,b=s.createElement("script"),d=s.createElement("div"),f="script"+J();d.style.display="none";d.innerHTML=" <link/><table></table><a href='/a' style='color:red;float:left;opacity:.55;'>a</a><input type='checkbox'/>";
+var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected,
+parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent=
+false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="<input type='radio' name='radiotest' checked='checked'/>";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n=
+s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true,
+applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando];
+else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this,
+a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b===
+w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i,
+cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d<f;d++){var e=this[d];if(e.nodeType===1)if(e.className){for(var j=" "+e.className+" ",
+i=e.className,o=0,k=b.length;o<k;o++)if(j.indexOf(" "+b[o]+" ")<0)i+=" "+b[o];e.className=c.trim(i)}else e.className=a}return this},removeClass:function(a){if(c.isFunction(a))return this.each(function(k){var n=c(this);n.removeClass(a.call(this,k,n.attr("class")))});if(a&&typeof a==="string"||a===w)for(var b=(a||"").split(ca),d=0,f=this.length;d<f;d++){var e=this[d];if(e.nodeType===1&&e.className)if(a){for(var j=(" "+e.className+" ").replace(Aa," "),i=0,o=b.length;i<o;i++)j=j.replace(" "+b[i]+" ",
+" ");e.className=c.trim(j)}else e.className=""}return this},toggleClass:function(a,b){var d=typeof a,f=typeof b==="boolean";if(c.isFunction(a))return this.each(function(e){var j=c(this);j.toggleClass(a.call(this,e,j.attr("class"),b),b)});return this.each(function(){if(d==="string")for(var e,j=0,i=c(this),o=b,k=a.split(ca);e=k[j++];){o=f?o:!i.hasClass(e);i[o?"addClass":"removeClass"](e)}else if(d==="undefined"||d==="boolean"){this.className&&c.data(this,"__className__",this.className);this.className=
+this.className||a===false?"":c.data(this,"__className__")||""}})},hasClass:function(a){a=" "+a+" ";for(var b=0,d=this.length;b<d;b++)if((" "+this[b].className+" ").replace(Aa," ").indexOf(a)>-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j<d;j++){var i=
+e[j];if(i.selected){a=c(i).val();if(b)return a;f.push(a)}}return f}if(Ba.test(b.type)&&!c.support.checkOn)return b.getAttribute("value")===null?"on":b.value;return(b.value||"").replace(Za,"")}return w}var o=c.isFunction(a);return this.each(function(k){var n=c(this),r=a;if(this.nodeType===1){if(o)r=a.call(this,k,n.val());if(typeof r==="number")r+="";if(c.isArray(r)&&Ba.test(this.type))this.checked=c.inArray(n.val(),r)>=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected=
+c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed");
+a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g,
+function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split(".");
+k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a),
+C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B<r.length;B++){u=r[B];if(d.guid===u.guid){if(i||k.test(u.namespace)){f==null&&r.splice(B--,1);n.remove&&n.remove.call(a,u)}if(f!=
+null)break}}if(r.length===0||f!=null&&r.length===1){if(!n.teardown||n.teardown.call(a,o)===false)Ca(a,e,z.handle);delete C[e]}}else for(var B=0;B<r.length;B++){u=r[B];if(i||k.test(u.namespace)){c.event.remove(a,n,u.handler,B);r.splice(B--,1)}}}if(c.isEmptyObject(C)){if(b=z.handle)b.elem=null;delete z.events;delete z.handle;c.isEmptyObject(z)&&c.removeData(a)}}}}},trigger:function(a,b,d,f){var e=a.type||a;if(!f){a=typeof a==="object"?a[G]?a:c.extend(c.Event(e),a):c.Event(e);if(e.indexOf("!")>=0){a.type=
+e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&&
+f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive;
+if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e<j;e++){var i=d[e];if(b||f.test(i.namespace)){a.handler=i.handler;a.data=i.data;a.handleObj=i;i=i.handler.apply(this,arguments);if(i!==w){a.result=i;if(i===false){a.preventDefault();a.stopPropagation()}}if(a.isImmediatePropagationStopped())break}}}return a.result},props:"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode layerX layerY metaKey newValue offsetX offsetY originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),
+fix:function(a){if(a[G])return a;var b=a;a=c.Event(b);for(var d=this.props.length,f;d;){f=this.props[--d];a[f]=b[f]}if(!a.target)a.target=a.srcElement||s;if(a.target.nodeType===3)a.target=a.target.parentNode;if(!a.relatedTarget&&a.fromElement)a.relatedTarget=a.fromElement===a.target?a.toElement:a.fromElement;if(a.pageX==null&&a.clientX!=null){b=s.documentElement;d=s.body;a.pageX=a.clientX+(b&&b.scrollLeft||d&&d.scrollLeft||0)-(b&&b.clientLeft||d&&d.clientLeft||0);a.pageY=a.clientY+(b&&b.scrollTop||
+d&&d.scrollTop||0)-(b&&b.clientTop||d&&d.clientTop||0)}if(!a.which&&(a.charCode||a.charCode===0?a.charCode:a.keyCode))a.which=a.charCode||a.keyCode;if(!a.metaKey&&a.ctrlKey)a.metaKey=a.ctrlKey;if(!a.which&&a.button!==w)a.which=a.button&1?1:a.button&2?3:a.button&4?2:0;return a},guid:1E8,proxy:c.proxy,special:{ready:{setup:c.bindReady,teardown:c.noop},live:{add:function(a){c.event.add(this,a.origType,c.extend({},a,{handler:oa}))},remove:function(a){var b=true,d=a.origType.replace(O,"");c.each(c.data(this,
+"events").live||[],function(){if(d===this.origType.replace(O,""))return b=false});b&&c.event.remove(this,a.origType,oa)}},beforeunload:{setup:function(a,b,d){if(this.setInterval)this.onbeforeunload=d;return false},teardown:function(a,b){if(this.onbeforeunload===b)this.onbeforeunload=null}}}};var Ca=s.removeEventListener?function(a,b,d){a.removeEventListener(b,d,false)}:function(a,b,d){a.detachEvent("on"+b,d)};c.Event=function(a){if(!this.preventDefault)return new c.Event(a);if(a&&a.type){this.originalEvent=
+a;this.type=a.type}else this.type=a;this.timeStamp=J();this[G]=true};c.Event.prototype={preventDefault:function(){this.isDefaultPrevented=Z;var a=this.originalEvent;if(a){a.preventDefault&&a.preventDefault();a.returnValue=false}},stopPropagation:function(){this.isPropagationStopped=Z;var a=this.originalEvent;if(a){a.stopPropagation&&a.stopPropagation();a.cancelBubble=true}},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=Z;this.stopPropagation()},isDefaultPrevented:Y,isPropagationStopped:Y,
+isImmediatePropagationStopped:Y};var Da=function(a){var b=a.relatedTarget;try{for(;b&&b!==this;)b=b.parentNode;if(b!==this){a.type=a.data;c.event.handle.apply(this,arguments)}}catch(d){}},Ea=function(a){a.type=a.data;c.event.handle.apply(this,arguments)};c.each({mouseenter:"mouseover",mouseleave:"mouseout"},function(a,b){c.event.special[a]={setup:function(d){c.event.add(this,b,d&&d.selector?Ea:Da,a)},teardown:function(d){c.event.remove(this,b,d&&d.selector?Ea:Da)}}});if(!c.support.submitBubbles)c.event.special.submit=
+{setup:function(){if(this.nodeName.toLowerCase()!=="form"){c.event.add(this,"click.specialSubmit",function(a){var b=a.target,d=b.type;if((d==="submit"||d==="image")&&c(b).closest("form").length)return na("submit",this,arguments)});c.event.add(this,"keypress.specialSubmit",function(a){var b=a.target,d=b.type;if((d==="text"||d==="password")&&c(b).closest("form").length&&a.keyCode===13)return na("submit",this,arguments)})}else return false},teardown:function(){c.event.remove(this,".specialSubmit")}};
+if(!c.support.changeBubbles){var da=/textarea|input|select/i,ea,Fa=function(a){var b=a.type,d=a.value;if(b==="radio"||b==="checkbox")d=a.checked;else if(b==="select-multiple")d=a.selectedIndex>-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data",
+e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a,
+"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a,
+d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j<o;j++)c.event.add(this[j],d,i,f)}return this}});c.fn.extend({unbind:function(a,b){if(typeof a==="object"&&
+!a.preventDefault)for(var d in a)this.unbind(d,a[d]);else{d=0;for(var f=this.length;d<f;d++)c.event.remove(this[d],a,b)}return this},delegate:function(a,b,d,f){return this.live(b,d,f,a)},undelegate:function(a,b,d){return arguments.length===0?this.unbind("live"):this.die(b,null,d,a)},trigger:function(a,b){return this.each(function(){c.event.trigger(a,b,this)})},triggerHandler:function(a,b){if(this[0]){a=c.Event(a);a.preventDefault();a.stopPropagation();c.event.trigger(a,b,this[0]);return a.result}},
+toggle:function(a){for(var b=arguments,d=1;d<b.length;)c.proxy(a,b[d++]);return this.click(c.proxy(a,function(f){var e=(c.data(this,"lastToggle"+a.guid)||0)%d;c.data(this,"lastToggle"+a.guid,e+1);f.preventDefault();return b[e].apply(this,arguments)||false}))},hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}});var Ga={focus:"focusin",blur:"focusout",mouseenter:"mouseover",mouseleave:"mouseout"};c.each(["live","die"],function(a,b){c.fn[b]=function(d,f,e,j){var i,o=0,k,n,r=j||this.selector,
+u=j?this:c(this.context);if(c.isFunction(f)){e=f;f=w}for(d=(d||"").split(" ");(i=d[o++])!=null;){j=O.exec(i);k="";if(j){k=j[0];i=i.replace(O,"")}if(i==="hover")d.push("mouseenter"+k,"mouseleave"+k);else{n=i;if(i==="focus"||i==="blur"){d.push(Ga[i]+k);i+=k}else i=(Ga[i]||i)+k;b==="live"?u.each(function(){c.event.add(this,pa(i,r),{data:f,selector:r,handler:e,origType:i,origHandler:e,preType:n})}):u.unbind(pa(i,r),e)}}return this}});c.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error".split(" "),
+function(a,b){c.fn[b]=function(d){return d?this.bind(b,d):this.trigger(b)};if(c.attrFn)c.attrFn[b]=true});A.attachEvent&&!A.addEventListener&&A.attachEvent("onunload",function(){for(var a in c.cache)if(c.cache[a].handle)try{c.event.remove(c.cache[a].handle.elem)}catch(b){}});(function(){function a(g){for(var h="",l,m=0;g[m];m++){l=g[m];if(l.nodeType===3||l.nodeType===4)h+=l.nodeValue;else if(l.nodeType!==8)h+=a(l.childNodes)}return h}function b(g,h,l,m,q,p){q=0;for(var v=m.length;q<v;q++){var t=m[q];
+if(t){t=t[g];for(var y=false;t;){if(t.sizcache===l){y=m[t.sizset];break}if(t.nodeType===1&&!p){t.sizcache=l;t.sizset=q}if(t.nodeName.toLowerCase()===h){y=t;break}t=t[g]}m[q]=y}}}function d(g,h,l,m,q,p){q=0;for(var v=m.length;q<v;q++){var t=m[q];if(t){t=t[g];for(var y=false;t;){if(t.sizcache===l){y=m[t.sizset];break}if(t.nodeType===1){if(!p){t.sizcache=l;t.sizset=q}if(typeof h!=="string"){if(t===h){y=true;break}}else if(k.filter(h,[t]).length>0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,
+e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift();
+t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D||
+g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h<g.length;h++)g[h]===g[h-1]&&g.splice(h--,1)}return g};k.matches=function(g,h){return k(g,null,null,h)};k.find=function(g,h,l){var m,q;if(!g)return[];
+for(var p=0,v=n.order.length;p<v;p++){var t=n.order[p];if(q=n.leftMatch[t].exec(g)){var y=q[1];q.splice(1,1);if(y.substr(y.length-1)!=="\\"){q[1]=(q[1]||"").replace(/\\/g,"");m=n.find[t](q,h,l);if(m!=null){g=g.replace(n.match[t],"");break}}}}m||(m=h.getElementsByTagName("*"));return{set:m,expr:g}};k.filter=function(g,h,l,m){for(var q=g,p=[],v=h,t,y,S=h&&h[0]&&x(h[0]);g&&h.length;){for(var H in n.filter)if((t=n.leftMatch[H].exec(g))!=null&&t[2]){var M=n.filter[H],I,D;D=t[1];y=false;t.splice(1,1);if(D.substr(D.length-
+1)!=="\\"){if(v===p)p=[];if(n.preFilter[H])if(t=n.preFilter[H](t,v,l,p,m,S)){if(t===true)continue}else y=I=true;if(t)for(var U=0;(D=v[U])!=null;U++)if(D){I=M(D,t,U,v);var Ha=m^!!I;if(l&&I!=null)if(Ha)y=true;else v[U]=false;else if(Ha){p.push(D);y=true}}if(I!==w){l||(v=p);g=g.replace(n.match[H],"");if(!y)return[];break}}}if(g===q)if(y==null)k.error(g);else break;q=g}return v};k.error=function(g){throw"Syntax error, unrecognized expression: "+g;};var n=k.selectors={order:["ID","NAME","TAG"],match:{ID:/#((?:[\w\u00c0-\uFFFF-]|\\.)+)/,
+CLASS:/\.((?:[\w\u00c0-\uFFFF-]|\\.)+)/,NAME:/\[name=['"]*((?:[\w\u00c0-\uFFFF-]|\\.)+)['"]*\]/,ATTR:/\[\s*((?:[\w\u00c0-\uFFFF-]|\\.)+)\s*(?:(\S?=)\s*(['"]*)(.*?)\3|)\s*\]/,TAG:/^((?:[\w\u00c0-\uFFFF\*-]|\\.)+)/,CHILD:/:(only|nth|last|first)-child(?:\((even|odd|[\dn+-]*)\))?/,POS:/:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^-]|$)/,PSEUDO:/:((?:[\w\u00c0-\uFFFF-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/},leftMatch:{},attrMap:{"class":"className","for":"htmlFor"},attrHandle:{href:function(g){return g.getAttribute("href")}},
+relative:{"+":function(g,h){var l=typeof h==="string",m=l&&!/\W/.test(h);l=l&&!m;if(m)h=h.toLowerCase();m=0;for(var q=g.length,p;m<q;m++)if(p=g[m]){for(;(p=p.previousSibling)&&p.nodeType!==1;);g[m]=l||p&&p.nodeName.toLowerCase()===h?p||false:p===h}l&&k.filter(h,g,true)},">":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m<q;m++){var p=g[m];if(p){l=p.parentNode;g[m]=l.nodeName.toLowerCase()===h?l:false}}}else{m=0;for(q=g.length;m<q;m++)if(p=g[m])g[m]=
+l?p.parentNode:p.parentNode===h;l&&k.filter(h,g,true)}},"":function(g,h,l){var m=e++,q=d;if(typeof h==="string"&&!/\W/.test(h)){var p=h=h.toLowerCase();q=b}q("parentNode",h,m,g,p,l)},"~":function(g,h,l){var m=e++,q=d;if(typeof h==="string"&&!/\W/.test(h)){var p=h=h.toLowerCase();q=b}q("previousSibling",h,m,g,p,l)}},find:{ID:function(g,h,l){if(typeof h.getElementById!=="undefined"&&!l)return(g=h.getElementById(g[1]))?[g]:[]},NAME:function(g,h){if(typeof h.getElementsByName!=="undefined"){var l=[];
+h=h.getElementsByName(g[1]);for(var m=0,q=h.length;m<q;m++)h[m].getAttribute("name")===g[1]&&l.push(h[m]);return l.length===0?null:l}},TAG:function(g,h){return h.getElementsByTagName(g[1])}},preFilter:{CLASS:function(g,h,l,m,q,p){g=" "+g[1].replace(/\\/g,"")+" ";if(p)return g;p=0;for(var v;(v=h[p])!=null;p++)if(v)if(q^(v.className&&(" "+v.className+" ").replace(/[\t\n]/g," ").indexOf(g)>=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()},
+CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m,
+g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)},
+text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}},
+setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return h<l[3]-0},gt:function(g,h,l){return h>l[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h=
+h[3];l=0;for(m=h.length;l<m;l++)if(h[l]===g)return false;return true}else k.error("Syntax error, unrecognized expression: "+q)},CHILD:function(g,h){var l=h[1],m=g;switch(l){case "only":case "first":for(;m=m.previousSibling;)if(m.nodeType===1)return false;if(l==="first")return true;m=g;case "last":for(;m=m.nextSibling;)if(m.nodeType===1)return false;return true;case "nth":l=h[2];var q=h[3];if(l===1&&q===0)return true;h=h[0];var p=g.parentNode;if(p&&(p.sizcache!==h||!g.nodeIndex)){var v=0;for(m=p.firstChild;m;m=
+m.nextSibling)if(m.nodeType===1)m.nodeIndex=++v;p.sizcache=h}g=g.nodeIndex-q;return l===0?g===0:g%l===0&&g/l>=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m===
+"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g,
+h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l<m;l++)h.push(g[l]);else for(l=0;g[l];l++)h.push(g[l]);return h}}var B;if(s.documentElement.compareDocumentPosition)B=function(g,h){if(!g.compareDocumentPosition||
+!h.compareDocumentPosition){if(g==h)i=true;return g.compareDocumentPosition?-1:1}g=g.compareDocumentPosition(h)&4?-1:g===h?0:1;if(g===0)i=true;return g};else if("sourceIndex"in s.documentElement)B=function(g,h){if(!g.sourceIndex||!h.sourceIndex){if(g==h)i=true;return g.sourceIndex?-1:1}g=g.sourceIndex-h.sourceIndex;if(g===0)i=true;return g};else if(s.createRange)B=function(g,h){if(!g.ownerDocument||!h.ownerDocument){if(g==h)i=true;return g.ownerDocument?-1:1}var l=g.ownerDocument.createRange(),m=
+h.ownerDocument.createRange();l.setStart(g,0);l.setEnd(g,0);m.setStart(h,0);m.setEnd(h,0);g=l.compareBoundaryPoints(Range.START_TO_END,m);if(g===0)i=true;return g};(function(){var g=s.createElement("div"),h="script"+(new Date).getTime();g.innerHTML="<a name='"+h+"'/>";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&&
+q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML="<a href='#'></a>";
+if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="<p class='TEST'></p>";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}();
+(function(){var g=s.createElement("div");g.innerHTML="<div class='test e'></div><div class='test'></div>";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}:
+function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q<p;q++)k(g,h[q],l);return k.filter(m,l)};c.find=k;c.expr=k.selectors;c.expr[":"]=c.expr.filters;c.unique=k.uniqueSort;c.text=a;c.isXMLDoc=x;c.contains=E})();var eb=/Until$/,fb=/^(?:parents|prevUntil|prevAll)/,
+gb=/,/;R=Array.prototype.slice;var Ia=function(a,b,d){if(c.isFunction(b))return c.grep(a,function(e,j){return!!b.call(e,j,e)===d});else if(b.nodeType)return c.grep(a,function(e){return e===b===d});else if(typeof b==="string"){var f=c.grep(a,function(e){return e.nodeType===1});if(Ua.test(b))return c.filter(b,f,!d);else b=c.filter(b,f)}return c.grep(a,function(e){return c.inArray(e,b)>=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f<e;f++){d=b.length;
+c.find(a,this[f],b);if(f>0)for(var j=d;j<b.length;j++)for(var i=0;i<d;i++)if(b[i]===b[j]){b.splice(j--,1);break}}return b},has:function(a){var b=c(a);return this.filter(function(){for(var d=0,f=b.length;d<f;d++)if(c.contains(this,b[d]))return true})},not:function(a){return this.pushStack(Ia(this,a,false),"not",a)},filter:function(a){return this.pushStack(Ia(this,a,true),"filter",a)},is:function(a){return!!a&&c.filter(a,this).length>0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j=
+{},i;if(f&&a.length){e=0;for(var o=a.length;e<o;e++){i=a[e];j[i]||(j[i]=c.expr.match.POS.test(i)?c(i,b||this.context):i)}for(;f&&f.ownerDocument&&f!==b;){for(i in j){e=j[i];if(e.jquery?e.index(f)>-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a===
+"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode",
+d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")?
+a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType===
+1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/<tbody/i,jb=/<|&#?\w+;/,ta=/<script|<object|<embed|<option|<style/i,ua=/checked\s*(?:[^=]|=\s*.checked.)/i,Ma=function(a,b,d){return hb.test(d)?
+a:b+"></"+d+">"},F={option:[1,"<select multiple='multiple'>","</select>"],legend:[1,"<fieldset>","</fieldset>"],thead:[1,"<table>","</table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],col:[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"],area:[1,"<map>","</map>"],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div<div>","</div>"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d=
+c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this},
+wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})},
+prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,
+this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild);
+return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja,
+""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b<d;b++)if(this[b].nodeType===1){c.cleanData(this[b].getElementsByTagName("*"));this[b].innerHTML=a}}catch(f){this.empty().append(a)}}else c.isFunction(a)?this.each(function(e){var j=c(this),i=j.html();j.empty().append(function(){return a.call(this,e,i)})}):this.empty().append(a);return this},replaceWith:function(a){if(this[0]&&
+this[0].parentNode){if(c.isFunction(a))return this.each(function(b){var d=c(this),f=d.html();d.replaceWith(a.call(this,b,f))});if(typeof a!=="string")a=c(a).detach();return this.each(function(){var b=this.nextSibling,d=this.parentNode;c(this).remove();b?c(b).before(a):c(d).append(a)})}else return this.pushStack(c(c.isFunction(a)?a():a),"replaceWith",a)},detach:function(a){return this.remove(a,true)},domManip:function(a,b,d){function f(u){return c.nodeName(u,"table")?u.getElementsByTagName("tbody")[0]||
+u.appendChild(u.ownerDocument.createElement("tbody")):u}var e,j,i=a[0],o=[],k;if(!c.support.checkClone&&arguments.length===3&&typeof i==="string"&&ua.test(i))return this.each(function(){c(this).domManip(a,b,d,true)});if(c.isFunction(i))return this.each(function(u){var z=c(this);a[0]=i.call(this,u,b?z.html():w);z.domManip(a,b,d)});if(this[0]){e=i&&i.parentNode;e=c.support.parentNode&&e&&e.nodeType===11&&e.childNodes.length===this.length?{fragment:e}:sa(a,this,o);k=e.fragment;if(j=k.childNodes.length===
+1?(k=k.firstChild):k.firstChild){b=b&&c.nodeName(j,"tr");for(var n=0,r=this.length;n<r;n++)d.call(b?f(this[n],j):this[n],n>0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]);
+return this}else{e=0;for(var j=d.length;e<j;e++){var i=(e>0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["",
+""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]==="<table>"&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e=
+c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]?
+c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja=
+function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter=
+Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a,
+"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f=
+a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b=
+a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=/<script(.|\s)*?\/script>/gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!==
+"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("<div />").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this},
+serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),
+function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href,
+global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&&
+e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)?
+"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache===
+false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B=
+false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since",
+c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E||
+d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x);
+g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status===
+1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b===
+"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional;
+if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a<b;a++){var d=c.data(this[a],"olddisplay");
+this[a].style.display=d||"";if(c.css(this[a],"display")==="none"){d=this[a].nodeName;var f;if(la[d])f=la[d];else{var e=c("<"+d+" />").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a<b;a++)this[a].style.display=c.data(this[a],"olddisplay")||"";return this}},hide:function(a,b){if(a||a===0)return this.animate(K("hide",3),a,b);else{a=0;for(b=this.length;a<b;a++){var d=c.data(this[a],"olddisplay");!d&&d!=="none"&&c.data(this[a],
+"olddisplay",c.css(this[a],"display"))}a=0;for(b=this.length;a<b;a++)this[a].style.display="none";return this}},_toggle:c.fn.toggle,toggle:function(a,b){var d=typeof a==="boolean";if(c.isFunction(a)&&c.isFunction(b))this._toggle.apply(this,arguments);else a==null||d?this.each(function(){var f=d?a:c(this).is(":hidden");c(this)[f?"show":"hide"]()}):this.animate(K("toggle",3),a,b);return this},fadeTo:function(a,b,d){return this.filter(":hidden").css("opacity",0).show().end().animate({opacity:b},a,d)},
+animate:function(a,b,d,f){var e=c.speed(b,d,f);if(c.isEmptyObject(a))return this.each(e.complete);return this[e.queue===false?"each":"queue"](function(){var j=c.extend({},e),i,o=this.nodeType===1&&c(this).is(":hidden"),k=this;for(i in a){var n=i.replace(ia,ja);if(i!==n){a[n]=a[i];delete a[i];i=n}if(a[i]==="hide"&&o||a[i]==="show"&&!o)return j.complete.call(this);if((i==="height"||i==="width")&&this.style){j.display=c.css(this,"display");j.overflow=this.style.overflow}if(c.isArray(a[i])){(j.specialEasing=
+j.specialEasing||{})[i]=a[i][1];a[i]=a[i][0]}}if(j.overflow!=null)this.style.overflow="hidden";j.curAnim=c.extend({},a);c.each(a,function(r,u){var z=new c.fx(k,j,r);if(Ab.test(u))z[u==="toggle"?o?"show":"hide":u](a);else{var C=Bb.exec(u),B=z.cur(true)||0;if(C){u=parseFloat(C[2]);var E=C[3]||"px";if(E!=="px"){k.style[r]=(u||1)+E;B=(u||1)/z.cur(true)*B;k.style[r]=B+E}if(C[1])u=(C[1]==="-="?-1:1)*u+B;z.custom(B,u,E)}else z.custom(B,u,"")}});return true})},stop:function(a,b){var d=c.timers;a&&this.queue([]);
+this.each(function(){for(var f=d.length-1;f>=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration===
+"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]||
+c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start;
+this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now=
+this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem,
+e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b<a.length;b++)a[b]()||a.splice(b--,1);a.length||
+c.fx.stop()},stop:function(){clearInterval(W);W=null},speeds:{slow:600,fast:200,_default:400},step:{opacity:function(a){c.style(a.elem,"opacity",a.now)},_default:function(a){if(a.elem.style&&a.elem.style[a.prop]!=null)a.elem.style[a.prop]=(a.prop==="width"||a.prop==="height"?Math.max(0,a.now):a.now)+a.unit;else a.elem[a.prop]=a.now}}});if(c.expr&&c.expr.filters)c.expr.filters.animated=function(a){return c.grep(c.timers,function(b){return a===b.elem}).length};c.fn.offset="getBoundingClientRect"in s.documentElement?
+function(a){var b=this[0];if(a)return this.each(function(e){c.offset.setOffset(this,a,e)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return c.offset.bodyOffset(b);var d=b.getBoundingClientRect(),f=b.ownerDocument;b=f.body;f=f.documentElement;return{top:d.top+(self.pageYOffset||c.support.boxModel&&f.scrollTop||b.scrollTop)-(f.clientTop||b.clientTop||0),left:d.left+(self.pageXOffset||c.support.boxModel&&f.scrollLeft||b.scrollLeft)-(f.clientLeft||b.clientLeft||0)}}:function(a){var b=
+this[0];if(a)return this.each(function(r){c.offset.setOffset(this,a,r)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return c.offset.bodyOffset(b);c.offset.initialize();var d=b.offsetParent,f=b,e=b.ownerDocument,j,i=e.documentElement,o=e.body;f=(e=e.defaultView)?e.getComputedStyle(b,null):b.currentStyle;for(var k=b.offsetTop,n=b.offsetLeft;(b=b.parentNode)&&b!==o&&b!==i;){if(c.offset.supportsFixedPosition&&f.position==="fixed")break;j=e?e.getComputedStyle(b,null):b.currentStyle;
+k-=b.scrollTop;n-=b.scrollLeft;if(b===d){k+=b.offsetTop;n+=b.offsetLeft;if(c.offset.doesNotAddBorder&&!(c.offset.doesAddBorderForTableAndCells&&/^t(able|d|h)$/i.test(b.nodeName))){k+=parseFloat(j.borderTopWidth)||0;n+=parseFloat(j.borderLeftWidth)||0}f=d;d=b.offsetParent}if(c.offset.subtractsBorderForOverflowNotVisible&&j.overflow!=="visible"){k+=parseFloat(j.borderTopWidth)||0;n+=parseFloat(j.borderLeftWidth)||0}f=j}if(f.position==="relative"||f.position==="static"){k+=o.offsetTop;n+=o.offsetLeft}if(c.offset.supportsFixedPosition&&
+f.position==="fixed"){k+=Math.max(i.scrollTop,o.scrollTop);n+=Math.max(i.scrollLeft,o.scrollLeft)}return{top:k,left:n}};c.offset={initialize:function(){var a=s.body,b=s.createElement("div"),d,f,e,j=parseFloat(c.curCSS(a,"marginTop",true))||0;c.extend(b.style,{position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"});b.innerHTML="<div style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;'><div></div></div><table style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;' cellpadding='0' cellspacing='0'><tr><td></td></tr></table>";
+a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b);
+c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a,
+d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top-
+f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset":
+"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in
+e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window);
--- /dev/null
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #eeffcc; }
+.highlight .c { color: #408090; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #303030 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020 } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000 } /* Keyword.Type */
+.highlight .m { color: #208050 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #4070a0 } /* Name.Attribute */
+.highlight .nb { color: #007020 } /* Name.Builtin */
+.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+.highlight .no { color: #60add5 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #007020 } /* Name.Exception */
+.highlight .nf { color: #06287e } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #bb60d5 } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #208050 } /* Literal.Number.Float */
+.highlight .mh { color: #208050 } /* Literal.Number.Hex */
+.highlight .mi { color: #208050 } /* Literal.Number.Integer */
+.highlight .mo { color: #208050 } /* Literal.Number.Oct */
+.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
+.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
+.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
+.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #c65d09 } /* Literal.String.Other */
+.highlight .sr { color: #235388 } /* Literal.String.Regex */
+.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
+.highlight .ss { color: #517918 } /* Literal.String.Symbol */
+.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
+.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
+.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
--- /dev/null
+/*
+ * searchtools.js_t
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilties for the full-text search.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words, hlwords is the list of normal, unstemmed
+ * words. the first one is used to find the occurance, the
+ * latter for highlighting it.
+ */
+
+jQuery.makeSearchSummary = function(text, keywords, hlwords) {
+ var textLower = text.toLowerCase();
+ var start = 0;
+ $.each(keywords, function() {
+ var i = textLower.indexOf(this.toLowerCase());
+ if (i > -1)
+ start = i;
+ });
+ start = Math.max(start - 120, 0);
+ var excerpt = ((start > 0) ? '...' : '') +
+ $.trim(text.substr(start, 240)) +
+ ((start + 240 - text.length) ? '...' : '');
+ var rv = $('<div class="context"></div>').text(excerpt);
+ $.each(hlwords, function() {
+ rv = rv.highlightText(this, 'highlighted');
+ });
+ return rv;
+}
+
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
+
+/**
+ * Search Module
+ */
+var Search = {
+
+ _index : null,
+ _queued_query : null,
+ _pulse_status : -1,
+
+ init : function() {
+ var params = $.getQueryParameters();
+ if (params.q) {
+ var query = params.q[0];
+ $('input[name="q"]')[0].value = query;
+ this.performSearch(query);
+ }
+ },
+
+ loadIndex : function(url) {
+ $.ajax({type: "GET", url: url, data: null, success: null,
+ dataType: "script", cache: true});
+ },
+
+ setIndex : function(index) {
+ var q;
+ this._index = index;
+ if ((q = this._queued_query) !== null) {
+ this._queued_query = null;
+ Search.query(q);
+ }
+ },
+
+ hasIndex : function() {
+ return this._index !== null;
+ },
+
+ deferQuery : function(query) {
+ this._queued_query = query;
+ },
+
+ stopPulse : function() {
+ this._pulse_status = 0;
+ },
+
+ startPulse : function() {
+ if (this._pulse_status >= 0)
+ return;
+ function pulse() {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ var dotString = '';
+ for (var i = 0; i < Search._pulse_status; i++)
+ dotString += '.';
+ Search.dots.text(dotString);
+ if (Search._pulse_status > -1)
+ window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something
+ */
+ performSearch : function(query) {
+ // create the required interface elements
+ this.out = $('#search-results');
+ this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
+ this.dots = $('<span></span>').appendTo(this.title);
+ this.status = $('<p style="display: none"></p>').appendTo(this.out);
+ this.output = $('<ul class="search"/>').appendTo(this.out);
+
+ $('#search-progress').text(_('Preparing search...'));
+ this.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (this.hasIndex())
+ this.query(query);
+ else
+ this.deferQuery(query);
+ },
+
+ query : function(query) {
+ var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"];
+
+ // Stem the searchterms and add them to the correct list
+ var stemmer = new Stemmer();
+ var searchterms = [];
+ var excluded = [];
+ var hlterms = [];
+ var tmp = query.split(/\s+/);
+ var objectterms = [];
+ for (var i = 0; i < tmp.length; i++) {
+ if (tmp[i] != "") {
+ objectterms.push(tmp[i].toLowerCase());
+ }
+
+ if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) ||
+ tmp[i] == "") {
+ // skip this "word"
+ continue;
+ }
+ // stem the word
+ var word = stemmer.stemWord(tmp[i]).toLowerCase();
+ // select the correct list
+ if (word[0] == '-') {
+ var toAppend = excluded;
+ word = word.substr(1);
+ }
+ else {
+ var toAppend = searchterms;
+ hlterms.push(tmp[i].toLowerCase());
+ }
+ // only add if not already in the list
+ if (!$.contains(toAppend, word))
+ toAppend.push(word);
+ };
+ var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
+
+ // console.debug('SEARCH: searching for:');
+ // console.info('required: ', searchterms);
+ // console.info('excluded: ', excluded);
+
+ // prepare search
+ var filenames = this._index.filenames;
+ var titles = this._index.titles;
+ var terms = this._index.terms;
+ var fileMap = {};
+ var files = null;
+ // different result priorities
+ var importantResults = [];
+ var objectResults = [];
+ var regularResults = [];
+ var unimportantResults = [];
+ $('#search-progress').empty();
+
+ // lookup as object
+ for (var i = 0; i < objectterms.length; i++) {
+ var others = [].concat(objectterms.slice(0,i),
+ objectterms.slice(i+1, objectterms.length))
+ var results = this.performObjectSearch(objectterms[i], others);
+ // Assume first word is most likely to be the object,
+ // other words more likely to be in description.
+ // Therefore put matches for earlier words first.
+ // (Results are eventually used in reverse order).
+ objectResults = results[0].concat(objectResults);
+ importantResults = results[1].concat(importantResults);
+ unimportantResults = results[2].concat(unimportantResults);
+ }
+
+ // perform the search on the required terms
+ for (var i = 0; i < searchterms.length; i++) {
+ var word = searchterms[i];
+ // no match but word was a required one
+ if ((files = terms[word]) == null)
+ break;
+ if (files.length == undefined) {
+ files = [files];
+ }
+ // create the mapping
+ for (var j = 0; j < files.length; j++) {
+ var file = files[j];
+ if (file in fileMap)
+ fileMap[file].push(word);
+ else
+ fileMap[file] = [word];
+ }
+ }
+
+ // now check if the files don't contain excluded terms
+ for (var file in fileMap) {
+ var valid = true;
+
+ // check if all requirements are matched
+ if (fileMap[file].length != searchterms.length)
+ continue;
+
+ // ensure that none of the excluded terms is in the
+ // search result.
+ for (var i = 0; i < excluded.length; i++) {
+ if (terms[excluded[i]] == file ||
+ $.contains(terms[excluded[i]] || [], file)) {
+ valid = false;
+ break;
+ }
+ }
+
+ // if we have still a valid result we can add it
+ // to the result list
+ if (valid)
+ regularResults.push([filenames[file], titles[file], '', null]);
+ }
+
+ // delete unused variables in order to not waste
+ // memory until list is retrieved completely
+ delete filenames, titles, terms;
+
+ // now sort the regular results descending by title
+ regularResults.sort(function(a, b) {
+ var left = a[1].toLowerCase();
+ var right = b[1].toLowerCase();
+ return (left > right) ? -1 : ((left < right) ? 1 : 0);
+ });
+
+ // combine all results
+ var results = unimportantResults.concat(regularResults)
+ .concat(objectResults).concat(importantResults);
+
+ // print the results
+ var resultCount = results.length;
+ function displayNextItem() {
+ // results left, load the summary and display it
+ if (results.length) {
+ var item = results.pop();
+ var listItem = $('<li style="display:none"></li>');
+ if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') {
+ // dirhtml builder
+ var dirname = item[0] + '/';
+ if (dirname.match(/\/index\/$/)) {
+ dirname = dirname.substring(0, dirname.length-6);
+ } else if (dirname == 'index/') {
+ dirname = '';
+ }
+ listItem.append($('<a/>').attr('href',
+ DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
+ highlightstring + item[2]).html(item[1]));
+ } else {
+ // normal html builders
+ listItem.append($('<a/>').attr('href',
+ item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
+ highlightstring + item[2]).html(item[1]));
+ }
+ if (item[3]) {
+ listItem.append($('<span> (' + item[3] + ')</span>'));
+ Search.output.append(listItem);
+ listItem.slideDown(5, function() {
+ displayNextItem();
+ });
+ } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
+ $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' +
+ item[0] + '.txt', function(data) {
+ if (data != '') {
+ listItem.append($.makeSearchSummary(data, searchterms, hlterms));
+ Search.output.append(listItem);
+ }
+ listItem.slideDown(5, function() {
+ displayNextItem();
+ });
+ }, "text");
+ } else {
+ // no source available, just display title
+ Search.output.append(listItem);
+ listItem.slideDown(5, function() {
+ displayNextItem();
+ });
+ }
+ }
+ // search finished, update title and status message
+ else {
+ Search.stopPulse();
+ Search.title.text(_('Search Results'));
+ if (!resultCount)
+ Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
+ else
+ Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
+ Search.status.fadeIn(500);
+ }
+ }
+ displayNextItem();
+ },
+
+ performObjectSearch : function(object, otherterms) {
+ var filenames = this._index.filenames;
+ var objects = this._index.objects;
+ var objnames = this._index.objnames;
+ var titles = this._index.titles;
+
+ var importantResults = [];
+ var objectResults = [];
+ var unimportantResults = [];
+
+ for (var prefix in objects) {
+ for (var name in objects[prefix]) {
+ var fullname = (prefix ? prefix + '.' : '') + name;
+ if (fullname.toLowerCase().indexOf(object) > -1) {
+ var match = objects[prefix][name];
+ var objname = objnames[match[1]][2];
+ var title = titles[match[0]];
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ if (otherterms.length > 0) {
+ var haystack = (prefix + ' ' + name + ' ' +
+ objname + ' ' + title).toLowerCase();
+ var allfound = true;
+ for (var i = 0; i < otherterms.length; i++) {
+ if (haystack.indexOf(otherterms[i]) == -1) {
+ allfound = false;
+ break;
+ }
+ }
+ if (!allfound) {
+ continue;
+ }
+ }
+ var descr = objname + _(', in ') + title;
+ anchor = match[3];
+ if (anchor == '')
+ anchor = fullname;
+ else if (anchor == '-')
+ anchor = objnames[match[1]][1] + '-' + fullname;
+ result = [filenames[match[0]], fullname, '#'+anchor, descr];
+ switch (match[2]) {
+ case 1: objectResults.push(result); break;
+ case 0: importantResults.push(result); break;
+ case 2: unimportantResults.push(result); break;
+ }
+ }
+ }
+ }
+
+ // sort results descending
+ objectResults.sort(function(a, b) {
+ return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
+ });
+
+ importantResults.sort(function(a, b) {
+ return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
+ });
+
+ unimportantResults.sort(function(a, b) {
+ return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
+ });
+
+ return [importantResults, objectResults, unimportantResults]
+ }
+}
+
+$(document).ready(function() {
+ Search.init();
+});
\ No newline at end of file
--- /dev/null
+// Underscore.js 0.5.5
+// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc.
+// Underscore is freely distributable under the terms of the MIT license.
+// Portions of Underscore are inspired by or borrowed from Prototype.js,
+// Oliver Steele's Functional, and John Resig's Micro-Templating.
+// For all details and documentation:
+// http://documentcloud.github.com/underscore/
+(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e<f;e++)c.call(d,
+a[e],e,a);else{var g=b.keys(a);f=g.length;for(e=0;e<f;e++)c.call(d,a[g[e]],g[e],a)}}catch(h){if(h!=m)throw h;}return a};b.map=function(a,c,d){if(a&&b.isFunction(a.map))return a.map(c,d);var e=[];b.each(a,function(f,g,h){e.push(c.call(d,f,g,h))});return e};b.reduce=function(a,c,d,e){if(a&&b.isFunction(a.reduce))return a.reduce(b.bind(d,e),c);b.each(a,function(f,g,h){c=d.call(e,c,f,g,h)});return c};b.reduceRight=function(a,c,d,e){if(a&&b.isFunction(a.reduceRight))return a.reduceRight(b.bind(d,e),c);
+var f=b.clone(b.toArray(a)).reverse();b.each(f,function(g,h){c=d.call(e,c,g,h,a)});return c};b.detect=function(a,c,d){var e;b.each(a,function(f,g,h){if(c.call(d,f,g,h)){e=f;b.breakLoop()}});return e};b.select=function(a,c,d){if(a&&b.isFunction(a.filter))return a.filter(c,d);var e=[];b.each(a,function(f,g,h){c.call(d,f,g,h)&&e.push(f)});return e};b.reject=function(a,c,d){var e=[];b.each(a,function(f,g,h){!c.call(d,f,g,h)&&e.push(f)});return e};b.all=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.every))return a.every(c,
+d);var e=true;b.each(a,function(f,g,h){(e=e&&c.call(d,f,g,h))||b.breakLoop()});return e};b.any=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.some))return a.some(c,d);var e=false;b.each(a,function(f,g,h){if(e=c.call(d,f,g,h))b.breakLoop()});return e};b.include=function(a,c){if(b.isArray(a))return b.indexOf(a,c)!=-1;var d=false;b.each(a,function(e){if(d=e===c)b.breakLoop()});return d};b.invoke=function(a,c){var d=b.rest(arguments,2);return b.map(a,function(e){return(c?e[c]:e).apply(e,d)})};b.pluck=
+function(a,c){return b.map(a,function(d){return d[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);var e={computed:-Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g>=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g<e.computed&&(e={value:f,computed:g})});return e.value};b.sortBy=function(a,c,d){return b.pluck(b.map(a,
+function(e,f,g){return{value:e,criteria:c.call(d,e,f,g)}}).sort(function(e,f){e=e.criteria;f=f.criteria;return e<f?-1:e>f?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?(e=g+1):(f=g)}return e};b.toArray=function(a){if(!a)return[];if(a.toArray)return a.toArray();if(b.isArray(a))return a;if(b.isArguments(a))return k.call(a);return b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=function(a,c,d){return c&&!d?k.call(a,
+0,c):a[0]};b.rest=function(a,c,d){return k.call(a,b.isUndefined(c)||d?1:c)};b.last=function(a){return a[a.length-1]};b.compact=function(a){return b.select(a,function(c){return!!c})};b.flatten=function(a){return b.reduce(a,[],function(c,d){if(b.isArray(d))return c.concat(b.flatten(d));c.push(d);return c})};b.without=function(a){var c=b.rest(arguments);return b.select(a,function(d){return!b.include(c,d)})};b.uniq=function(a,c){return b.reduce(a,[],function(d,e,f){if(0==f||(c===true?b.last(d)!=e:!b.include(d,
+e)))d.push(e);return d})};b.intersect=function(a){var c=b.rest(arguments);return b.select(b.uniq(a),function(d){return b.all(c,function(e){return b.indexOf(e,d)>=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e<c;e++)d[e]=b.pluck(a,String(e));return d};b.indexOf=function(a,c){if(a.indexOf)return a.indexOf(c);for(var d=0,e=a.length;d<e;d++)if(a[d]===c)return d;return-1};b.lastIndexOf=function(a,c){if(a.lastIndexOf)return a.lastIndexOf(c);for(var d=
+a.length;d--;)if(a[d]===c)return d;return-1};b.range=function(a,c,d){var e=b.toArray(arguments),f=e.length<=1;a=f?0:e[0];c=f?e[0]:e[1];d=e[2]||1;e=Math.ceil((c-a)/d);if(e<=0)return[];e=new Array(e);f=a;for(var g=0;1;f+=d){if((d>0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)});
+return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length);
+var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false;
+if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length==
+0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&&
+a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g,
+" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments);
+o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})();
--- /dev/null
+/*
+ * websupport.js
+ * ~~~~~~~~~~~~~
+ *
+ * sphinx.websupport utilties for all documentation.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+(function($) {
+ $.fn.autogrow = function() {
+ return this.each(function() {
+ var textarea = this;
+
+ $.fn.autogrow.resize(textarea);
+
+ $(textarea)
+ .focus(function() {
+ textarea.interval = setInterval(function() {
+ $.fn.autogrow.resize(textarea);
+ }, 500);
+ })
+ .blur(function() {
+ clearInterval(textarea.interval);
+ });
+ });
+ };
+
+ $.fn.autogrow.resize = function(textarea) {
+ var lineHeight = parseInt($(textarea).css('line-height'), 10);
+ var lines = textarea.value.split('\n');
+ var columns = textarea.cols;
+ var lineCount = 0;
+ $.each(lines, function() {
+ lineCount += Math.ceil(this.length / columns) || 1;
+ });
+ var height = lineHeight * (lineCount + 1);
+ $(textarea).css('height', height);
+ };
+})(jQuery);
+
+(function($) {
+ var comp, by;
+
+ function init() {
+ initEvents();
+ initComparator();
+ }
+
+ function initEvents() {
+ $('a.comment-close').live("click", function(event) {
+ event.preventDefault();
+ hide($(this).attr('id').substring(2));
+ });
+ $('a.vote').live("click", function(event) {
+ event.preventDefault();
+ handleVote($(this));
+ });
+ $('a.reply').live("click", function(event) {
+ event.preventDefault();
+ openReply($(this).attr('id').substring(2));
+ });
+ $('a.close-reply').live("click", function(event) {
+ event.preventDefault();
+ closeReply($(this).attr('id').substring(2));
+ });
+ $('a.sort-option').live("click", function(event) {
+ event.preventDefault();
+ handleReSort($(this));
+ });
+ $('a.show-proposal').live("click", function(event) {
+ event.preventDefault();
+ showProposal($(this).attr('id').substring(2));
+ });
+ $('a.hide-proposal').live("click", function(event) {
+ event.preventDefault();
+ hideProposal($(this).attr('id').substring(2));
+ });
+ $('a.show-propose-change').live("click", function(event) {
+ event.preventDefault();
+ showProposeChange($(this).attr('id').substring(2));
+ });
+ $('a.hide-propose-change').live("click", function(event) {
+ event.preventDefault();
+ hideProposeChange($(this).attr('id').substring(2));
+ });
+ $('a.accept-comment').live("click", function(event) {
+ event.preventDefault();
+ acceptComment($(this).attr('id').substring(2));
+ });
+ $('a.delete-comment').live("click", function(event) {
+ event.preventDefault();
+ deleteComment($(this).attr('id').substring(2));
+ });
+ $('a.comment-markup').live("click", function(event) {
+ event.preventDefault();
+ toggleCommentMarkupBox($(this).attr('id').substring(2));
+ });
+ }
+
+ /**
+ * Set comp, which is a comparator function used for sorting and
+ * inserting comments into the list.
+ */
+ function setComparator() {
+ // If the first three letters are "asc", sort in ascending order
+ // and remove the prefix.
+ if (by.substring(0,3) == 'asc') {
+ var i = by.substring(3);
+ comp = function(a, b) { return a[i] - b[i]; };
+ } else {
+ // Otherwise sort in descending order.
+ comp = function(a, b) { return b[by] - a[by]; };
+ }
+
+ // Reset link styles and format the selected sort option.
+ $('a.sel').attr('href', '#').removeClass('sel');
+ $('a.by' + by).removeAttr('href').addClass('sel');
+ }
+
+ /**
+ * Create a comp function. If the user has preferences stored in
+ * the sortBy cookie, use those, otherwise use the default.
+ */
+ function initComparator() {
+ by = 'rating'; // Default to sort by rating.
+ // If the sortBy cookie is set, use that instead.
+ if (document.cookie.length > 0) {
+ var start = document.cookie.indexOf('sortBy=');
+ if (start != -1) {
+ start = start + 7;
+ var end = document.cookie.indexOf(";", start);
+ if (end == -1) {
+ end = document.cookie.length;
+ by = unescape(document.cookie.substring(start, end));
+ }
+ }
+ }
+ setComparator();
+ }
+
+ /**
+ * Show a comment div.
+ */
+ function show(id) {
+ $('#ao' + id).hide();
+ $('#ah' + id).show();
+ var context = $.extend({id: id}, opts);
+ var popup = $(renderTemplate(popupTemplate, context)).hide();
+ popup.find('textarea[name="proposal"]').hide();
+ popup.find('a.by' + by).addClass('sel');
+ var form = popup.find('#cf' + id);
+ form.submit(function(event) {
+ event.preventDefault();
+ addComment(form);
+ });
+ $('#s' + id).after(popup);
+ popup.slideDown('fast', function() {
+ getComments(id);
+ });
+ }
+
+ /**
+ * Hide a comment div.
+ */
+ function hide(id) {
+ $('#ah' + id).hide();
+ $('#ao' + id).show();
+ var div = $('#sc' + id);
+ div.slideUp('fast', function() {
+ div.remove();
+ });
+ }
+
+ /**
+ * Perform an ajax request to get comments for a node
+ * and insert the comments into the comments tree.
+ */
+ function getComments(id) {
+ $.ajax({
+ type: 'GET',
+ url: opts.getCommentsURL,
+ data: {node: id},
+ success: function(data, textStatus, request) {
+ var ul = $('#cl' + id);
+ var speed = 100;
+ $('#cf' + id)
+ .find('textarea[name="proposal"]')
+ .data('source', data.source);
+
+ if (data.comments.length === 0) {
+ ul.html('<li>No comments yet.</li>');
+ ul.data('empty', true);
+ } else {
+ // If there are comments, sort them and put them in the list.
+ var comments = sortComments(data.comments);
+ speed = data.comments.length * 100;
+ appendComments(comments, ul);
+ ul.data('empty', false);
+ }
+ $('#cn' + id).slideUp(speed + 200);
+ ul.slideDown(speed);
+ },
+ error: function(request, textStatus, error) {
+ showError('Oops, there was a problem retrieving the comments.');
+ },
+ dataType: 'json'
+ });
+ }
+
+ /**
+ * Add a comment via ajax and insert the comment into the comment tree.
+ */
+ function addComment(form) {
+ var node_id = form.find('input[name="node"]').val();
+ var parent_id = form.find('input[name="parent"]').val();
+ var text = form.find('textarea[name="comment"]').val();
+ var proposal = form.find('textarea[name="proposal"]').val();
+
+ if (text == '') {
+ showError('Please enter a comment.');
+ return;
+ }
+
+ // Disable the form that is being submitted.
+ form.find('textarea,input').attr('disabled', 'disabled');
+
+ // Send the comment to the server.
+ $.ajax({
+ type: "POST",
+ url: opts.addCommentURL,
+ dataType: 'json',
+ data: {
+ node: node_id,
+ parent: parent_id,
+ text: text,
+ proposal: proposal
+ },
+ success: function(data, textStatus, error) {
+ // Reset the form.
+ if (node_id) {
+ hideProposeChange(node_id);
+ }
+ form.find('textarea')
+ .val('')
+ .add(form.find('input'))
+ .removeAttr('disabled');
+ var ul = $('#cl' + (node_id || parent_id));
+ if (ul.data('empty')) {
+ $(ul).empty();
+ ul.data('empty', false);
+ }
+ insertComment(data.comment);
+ var ao = $('#ao' + node_id);
+ ao.find('img').attr({'src': opts.commentBrightImage});
+ if (node_id) {
+ // if this was a "root" comment, remove the commenting box
+ // (the user can get it back by reopening the comment popup)
+ $('#ca' + node_id).slideUp();
+ }
+ },
+ error: function(request, textStatus, error) {
+ form.find('textarea,input').removeAttr('disabled');
+ showError('Oops, there was a problem adding the comment.');
+ }
+ });
+ }
+
+ /**
+ * Recursively append comments to the main comment list and children
+ * lists, creating the comment tree.
+ */
+ function appendComments(comments, ul) {
+ $.each(comments, function() {
+ var div = createCommentDiv(this);
+ ul.append($(document.createElement('li')).html(div));
+ appendComments(this.children, div.find('ul.comment-children'));
+ // To avoid stagnating data, don't store the comments children in data.
+ this.children = null;
+ div.data('comment', this);
+ });
+ }
+
+ /**
+ * After adding a new comment, it must be inserted in the correct
+ * location in the comment tree.
+ */
+ function insertComment(comment) {
+ var div = createCommentDiv(comment);
+
+ // To avoid stagnating data, don't store the comments children in data.
+ comment.children = null;
+ div.data('comment', comment);
+
+ var ul = $('#cl' + (comment.node || comment.parent));
+ var siblings = getChildren(ul);
+
+ var li = $(document.createElement('li'));
+ li.hide();
+
+ // Determine where in the parents children list to insert this comment.
+ for(i=0; i < siblings.length; i++) {
+ if (comp(comment, siblings[i]) <= 0) {
+ $('#cd' + siblings[i].id)
+ .parent()
+ .before(li.html(div));
+ li.slideDown('fast');
+ return;
+ }
+ }
+
+ // If we get here, this comment rates lower than all the others,
+ // or it is the only comment in the list.
+ ul.append(li.html(div));
+ li.slideDown('fast');
+ }
+
+ function acceptComment(id) {
+ $.ajax({
+ type: 'POST',
+ url: opts.acceptCommentURL,
+ data: {id: id},
+ success: function(data, textStatus, request) {
+ $('#cm' + id).fadeOut('fast');
+ $('#cd' + id).removeClass('moderate');
+ },
+ error: function(request, textStatus, error) {
+ showError('Oops, there was a problem accepting the comment.');
+ }
+ });
+ }
+
+ function deleteComment(id) {
+ $.ajax({
+ type: 'POST',
+ url: opts.deleteCommentURL,
+ data: {id: id},
+ success: function(data, textStatus, request) {
+ var div = $('#cd' + id);
+ if (data == 'delete') {
+ // Moderator mode: remove the comment and all children immediately
+ div.slideUp('fast', function() {
+ div.remove();
+ });
+ return;
+ }
+ // User mode: only mark the comment as deleted
+ div
+ .find('span.user-id:first')
+ .text('[deleted]').end()
+ .find('div.comment-text:first')
+ .text('[deleted]').end()
+ .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
+ ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
+ .remove();
+ var comment = div.data('comment');
+ comment.username = '[deleted]';
+ comment.text = '[deleted]';
+ div.data('comment', comment);
+ },
+ error: function(request, textStatus, error) {
+ showError('Oops, there was a problem deleting the comment.');
+ }
+ });
+ }
+
+ function showProposal(id) {
+ $('#sp' + id).hide();
+ $('#hp' + id).show();
+ $('#pr' + id).slideDown('fast');
+ }
+
+ function hideProposal(id) {
+ $('#hp' + id).hide();
+ $('#sp' + id).show();
+ $('#pr' + id).slideUp('fast');
+ }
+
+ function showProposeChange(id) {
+ $('#pc' + id).hide();
+ $('#hc' + id).show();
+ var textarea = $('#pt' + id);
+ textarea.val(textarea.data('source'));
+ $.fn.autogrow.resize(textarea[0]);
+ textarea.slideDown('fast');
+ }
+
+ function hideProposeChange(id) {
+ $('#hc' + id).hide();
+ $('#pc' + id).show();
+ var textarea = $('#pt' + id);
+ textarea.val('').removeAttr('disabled');
+ textarea.slideUp('fast');
+ }
+
+ function toggleCommentMarkupBox(id) {
+ $('#mb' + id).toggle();
+ }
+
+ /** Handle when the user clicks on a sort by link. */
+ function handleReSort(link) {
+ var classes = link.attr('class').split(/\s+/);
+ for (var i=0; i<classes.length; i++) {
+ if (classes[i] != 'sort-option') {
+ by = classes[i].substring(2);
+ }
+ }
+ setComparator();
+ // Save/update the sortBy cookie.
+ var expiration = new Date();
+ expiration.setDate(expiration.getDate() + 365);
+ document.cookie= 'sortBy=' + escape(by) +
+ ';expires=' + expiration.toUTCString();
+ $('ul.comment-ul').each(function(index, ul) {
+ var comments = getChildren($(ul), true);
+ comments = sortComments(comments);
+ appendComments(comments, $(ul).empty());
+ });
+ }
+
+ /**
+ * Function to process a vote when a user clicks an arrow.
+ */
+ function handleVote(link) {
+ if (!opts.voting) {
+ showError("You'll need to login to vote.");
+ return;
+ }
+
+ var id = link.attr('id');
+ if (!id) {
+ // Didn't click on one of the voting arrows.
+ return;
+ }
+ // If it is an unvote, the new vote value is 0,
+ // Otherwise it's 1 for an upvote, or -1 for a downvote.
+ var value = 0;
+ if (id.charAt(1) != 'u') {
+ value = id.charAt(0) == 'u' ? 1 : -1;
+ }
+ // The data to be sent to the server.
+ var d = {
+ comment_id: id.substring(2),
+ value: value
+ };
+
+ // Swap the vote and unvote links.
+ link.hide();
+ $('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
+ .show();
+
+ // The div the comment is displayed in.
+ var div = $('div#cd' + d.comment_id);
+ var data = div.data('comment');
+
+ // If this is not an unvote, and the other vote arrow has
+ // already been pressed, unpress it.
+ if ((d.value !== 0) && (data.vote === d.value * -1)) {
+ $('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
+ $('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
+ }
+
+ // Update the comments rating in the local data.
+ data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
+ data.vote = d.value;
+ div.data('comment', data);
+
+ // Change the rating text.
+ div.find('.rating:first')
+ .text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
+
+ // Send the vote information to the server.
+ $.ajax({
+ type: "POST",
+ url: opts.processVoteURL,
+ data: d,
+ error: function(request, textStatus, error) {
+ showError('Oops, there was a problem casting that vote.');
+ }
+ });
+ }
+
+ /**
+ * Open a reply form used to reply to an existing comment.
+ */
+ function openReply(id) {
+ // Swap out the reply link for the hide link
+ $('#rl' + id).hide();
+ $('#cr' + id).show();
+
+ // Add the reply li to the children ul.
+ var div = $(renderTemplate(replyTemplate, {id: id})).hide();
+ $('#cl' + id)
+ .prepend(div)
+ // Setup the submit handler for the reply form.
+ .find('#rf' + id)
+ .submit(function(event) {
+ event.preventDefault();
+ addComment($('#rf' + id));
+ closeReply(id);
+ })
+ .find('input[type=button]')
+ .click(function() {
+ closeReply(id);
+ });
+ div.slideDown('fast', function() {
+ $('#rf' + id).find('textarea').focus();
+ });
+ }
+
+ /**
+ * Close the reply form opened with openReply.
+ */
+ function closeReply(id) {
+ // Remove the reply div from the DOM.
+ $('#rd' + id).slideUp('fast', function() {
+ $(this).remove();
+ });
+
+ // Swap out the hide link for the reply link
+ $('#cr' + id).hide();
+ $('#rl' + id).show();
+ }
+
+ /**
+ * Recursively sort a tree of comments using the comp comparator.
+ */
+ function sortComments(comments) {
+ comments.sort(comp);
+ $.each(comments, function() {
+ this.children = sortComments(this.children);
+ });
+ return comments;
+ }
+
+ /**
+ * Get the children comments from a ul. If recursive is true,
+ * recursively include childrens' children.
+ */
+ function getChildren(ul, recursive) {
+ var children = [];
+ ul.children().children("[id^='cd']")
+ .each(function() {
+ var comment = $(this).data('comment');
+ if (recursive)
+ comment.children = getChildren($(this).find('#cl' + comment.id), true);
+ children.push(comment);
+ });
+ return children;
+ }
+
+ /** Create a div to display a comment in. */
+ function createCommentDiv(comment) {
+ if (!comment.displayed && !opts.moderator) {
+ return $('<div class="moderate">Thank you! Your comment will show up '
+ + 'once it is has been approved by a moderator.</div>');
+ }
+ // Prettify the comment rating.
+ comment.pretty_rating = comment.rating + ' point' +
+ (comment.rating == 1 ? '' : 's');
+ // Make a class (for displaying not yet moderated comments differently)
+ comment.css_class = comment.displayed ? '' : ' moderate';
+ // Create a div for this comment.
+ var context = $.extend({}, opts, comment);
+ var div = $(renderTemplate(commentTemplate, context));
+
+ // If the user has voted on this comment, highlight the correct arrow.
+ if (comment.vote) {
+ var direction = (comment.vote == 1) ? 'u' : 'd';
+ div.find('#' + direction + 'v' + comment.id).hide();
+ div.find('#' + direction + 'u' + comment.id).show();
+ }
+
+ if (opts.moderator || comment.text != '[deleted]') {
+ div.find('a.reply').show();
+ if (comment.proposal_diff)
+ div.find('#sp' + comment.id).show();
+ if (opts.moderator && !comment.displayed)
+ div.find('#cm' + comment.id).show();
+ if (opts.moderator || (opts.username == comment.username))
+ div.find('#dc' + comment.id).show();
+ }
+ return div;
+ }
+
+ /**
+ * A simple template renderer. Placeholders such as <%id%> are replaced
+ * by context['id'] with items being escaped. Placeholders such as <#id#>
+ * are not escaped.
+ */
+ function renderTemplate(template, context) {
+ var esc = $(document.createElement('div'));
+
+ function handle(ph, escape) {
+ var cur = context;
+ $.each(ph.split('.'), function() {
+ cur = cur[this];
+ });
+ return escape ? esc.text(cur || "").html() : cur;
+ }
+
+ return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
+ return handle(arguments[2], arguments[1] == '%' ? true : false);
+ });
+ }
+
+ /** Flash an error message briefly. */
+ function showError(message) {
+ $(document.createElement('div')).attr({'class': 'popup-error'})
+ .append($(document.createElement('div'))
+ .attr({'class': 'error-message'}).text(message))
+ .appendTo('body')
+ .fadeIn("slow")
+ .delay(2000)
+ .fadeOut("slow");
+ }
+
+ /** Add a link the user uses to open the comments popup. */
+ $.fn.comment = function() {
+ return this.each(function() {
+ var id = $(this).attr('id').substring(1);
+ var count = COMMENT_METADATA[id];
+ var title = count + ' comment' + (count == 1 ? '' : 's');
+ var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
+ var addcls = count == 0 ? ' nocomment' : '';
+ $(this)
+ .append(
+ $(document.createElement('a')).attr({
+ href: '#',
+ 'class': 'sphinx-comment-open' + addcls,
+ id: 'ao' + id
+ })
+ .append($(document.createElement('img')).attr({
+ src: image,
+ alt: 'comment',
+ title: title
+ }))
+ .click(function(event) {
+ event.preventDefault();
+ show($(this).attr('id').substring(2));
+ })
+ )
+ .append(
+ $(document.createElement('a')).attr({
+ href: '#',
+ 'class': 'sphinx-comment-close hidden',
+ id: 'ah' + id
+ })
+ .append($(document.createElement('img')).attr({
+ src: opts.closeCommentImage,
+ alt: 'close',
+ title: 'close'
+ }))
+ .click(function(event) {
+ event.preventDefault();
+ hide($(this).attr('id').substring(2));
+ })
+ );
+ });
+ };
+
+ var opts = {
+ processVoteURL: '/_process_vote',
+ addCommentURL: '/_add_comment',
+ getCommentsURL: '/_get_comments',
+ acceptCommentURL: '/_accept_comment',
+ deleteCommentURL: '/_delete_comment',
+ commentImage: '/static/_static/comment.png',
+ closeCommentImage: '/static/_static/comment-close.png',
+ loadingImage: '/static/_static/ajax-loader.gif',
+ commentBrightImage: '/static/_static/comment-bright.png',
+ upArrow: '/static/_static/up.png',
+ downArrow: '/static/_static/down.png',
+ upArrowPressed: '/static/_static/up-pressed.png',
+ downArrowPressed: '/static/_static/down-pressed.png',
+ voting: false,
+ moderator: false
+ };
+
+ if (typeof COMMENT_OPTIONS != "undefined") {
+ opts = jQuery.extend(opts, COMMENT_OPTIONS);
+ }
+
+ var popupTemplate = '\
+ <div class="sphinx-comments" id="sc<%id%>">\
+ <p class="sort-options">\
+ Sort by:\
+ <a href="#" class="sort-option byrating">best rated</a>\
+ <a href="#" class="sort-option byascage">newest</a>\
+ <a href="#" class="sort-option byage">oldest</a>\
+ </p>\
+ <div class="comment-header">Comments</div>\
+ <div class="comment-loading" id="cn<%id%>">\
+ loading comments... <img src="<%loadingImage%>" alt="" /></div>\
+ <ul id="cl<%id%>" class="comment-ul"></ul>\
+ <div id="ca<%id%>">\
+ <p class="add-a-comment">Add a comment\
+ (<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
+ <div class="comment-markup-box" id="mb<%id%>">\
+ reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
+ <tt>``code``</tt>, \
+ code blocks: <tt>::</tt> and an indented block after blank line</div>\
+ <form method="post" id="cf<%id%>" class="comment-form" action="">\
+ <textarea name="comment" cols="80"></textarea>\
+ <p class="propose-button">\
+ <a href="#" id="pc<%id%>" class="show-propose-change">\
+ Propose a change ▹\
+ </a>\
+ <a href="#" id="hc<%id%>" class="hide-propose-change">\
+ Propose a change ▿\
+ </a>\
+ </p>\
+ <textarea name="proposal" id="pt<%id%>" cols="80"\
+ spellcheck="false"></textarea>\
+ <input type="submit" value="Add comment" />\
+ <input type="hidden" name="node" value="<%id%>" />\
+ <input type="hidden" name="parent" value="" />\
+ </form>\
+ </div>\
+ </div>';
+
+ var commentTemplate = '\
+ <div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
+ <div class="vote">\
+ <div class="arrow">\
+ <a href="#" id="uv<%id%>" class="vote" title="vote up">\
+ <img src="<%upArrow%>" />\
+ </a>\
+ <a href="#" id="uu<%id%>" class="un vote" title="vote up">\
+ <img src="<%upArrowPressed%>" />\
+ </a>\
+ </div>\
+ <div class="arrow">\
+ <a href="#" id="dv<%id%>" class="vote" title="vote down">\
+ <img src="<%downArrow%>" id="da<%id%>" />\
+ </a>\
+ <a href="#" id="du<%id%>" class="un vote" title="vote down">\
+ <img src="<%downArrowPressed%>" />\
+ </a>\
+ </div>\
+ </div>\
+ <div class="comment-content">\
+ <p class="tagline comment">\
+ <span class="user-id"><%username%></span>\
+ <span class="rating"><%pretty_rating%></span>\
+ <span class="delta"><%time.delta%></span>\
+ </p>\
+ <div class="comment-text comment"><#text#></div>\
+ <p class="comment-opts comment">\
+ <a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
+ <a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
+ <a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
+ <a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
+ <a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
+ <span id="cm<%id%>" class="moderation hidden">\
+ <a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
+ </span>\
+ </p>\
+ <pre class="proposal" id="pr<%id%>">\
+<#proposal_diff#>\
+ </pre>\
+ <ul class="comment-children" id="cl<%id%>"></ul>\
+ </div>\
+ <div class="clearleft"></div>\
+ </div>\
+ </div>';
+
+ var replyTemplate = '\
+ <li>\
+ <div class="reply-div" id="rd<%id%>">\
+ <form id="rf<%id%>">\
+ <textarea name="comment" cols="80"></textarea>\
+ <input type="submit" value="Add reply" />\
+ <input type="button" value="Cancel" />\
+ <input type="hidden" name="parent" value="<%id%>" />\
+ <input type="hidden" name="node" value="" />\
+ </form>\
+ </div>\
+ </li>';
+
+ $(document).ready(function() {
+ init();
+ });
+})(jQuery);
+
+$(document).ready(function() {
+ // add comment anchors for all paragraphs that are commentable
+ $('.sphinx-has-comment').comment();
+
+ // highlight search words in search results
+ $("div.context").each(function() {
+ var params = $.getQueryParameters();
+ var terms = (params.q) ? params.q[0].split(/\s+/) : [];
+ var result = $(this);
+ $.each(terms, function() {
+ result.highlightText(this.toLowerCase(), 'highlighted');
+ });
+ });
+
+ // directly open comment window if requested
+ var anchor = document.location.hash;
+ if (anchor.substring(0, 9) == '#comment-') {
+ $('#ao' + anchor.substring(9)).click();
+ document.location.hash = '#s' + anchor.substring(9);
+ }
+});
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="next" title="src Package" href="src.html" />
+ <link rel="prev" title="Add a user custom command" href="../../write_command.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="src">
+<h1>src<a class="headerlink" href="#src" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="src.html">src Package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="src.html#id1"><tt class="docutils literal"><span class="pre">src</span></tt> Package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.ElementTree"><tt class="docutils literal"><span class="pre">ElementTree</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.architecture"><tt class="docutils literal"><span class="pre">architecture</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.compilation"><tt class="docutils literal"><span class="pre">compilation</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.debug"><tt class="docutils literal"><span class="pre">debug</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.environment"><tt class="docutils literal"><span class="pre">environment</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fileEnviron"><tt class="docutils literal"><span class="pre">fileEnviron</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fork"><tt class="docutils literal"><span class="pre">fork</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.logger"><tt class="docutils literal"><span class="pre">logger</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.options"><tt class="docutils literal"><span class="pre">options</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.printcolors"><tt class="docutils literal"><span class="pre">printcolors</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.product"><tt class="docutils literal"><span class="pre">product</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.pyconf"><tt class="docutils literal"><span class="pre">pyconf</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.system"><tt class="docutils literal"><span class="pre">system</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.template"><tt class="docutils literal"><span class="pre">template</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.test_module"><tt class="docutils literal"><span class="pre">test_module</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.xmlManager"><tt class="docutils literal"><span class="pre">xmlManager</span></tt> Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="src.colorama.html">colorama Package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#id1"><tt class="docutils literal"><span class="pre">colorama</span></tt> Package</a></li>
+<li class="toctree-l4"><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>
+<li class="toctree-l4"><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>
+<li class="toctree-l4"><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>
+<li class="toctree-l4"><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>
+<li class="toctree-l4"><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>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="../../write_command.html" title="previous chapter">Add a user custom command</a></li>
+ <li>Next: <a href="src.html" title="next chapter">src Package</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../../_sources/commands/apidoc/modules.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../../_sources/commands/apidoc/modules.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>colorama Package — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="src Package" href="src.html" />
+ <link rel="next" title="Release notes" href="../../release_notes/release_notes_5.0.0.html" />
+ <link rel="prev" title="src Package" href="src.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="colorama-package">
+<h1>colorama Package<a class="headerlink" href="#colorama-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="id1">
+<h2><tt class="xref py py-mod docutils literal"><span class="pre">colorama</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<span class="target" id="module-src.colorama"></span></div>
+<div class="section" id="module-src.colorama.ansi">
+<span id="ansi-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ansi</span></tt> Module<a class="headerlink" href="#module-src.colorama.ansi" title="Permalink to this headline">¶</a></h2>
+<p>This module generates ANSI character codes to printing colors to terminals.
+See: <a class="reference external" href="http://en.wikipedia.org/wiki/ANSI_escape_code">http://en.wikipedia.org/wiki/ANSI_escape_code</a></p>
+<dl class="class">
+<dt id="src.colorama.ansi.AnsiBack">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">AnsiBack</tt><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiBack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiBack" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><tt class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></tt></a></p>
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.BLACK">
+<tt class="descname">BLACK</tt><em class="property"> = 40</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.BLACK" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.BLUE">
+<tt class="descname">BLUE</tt><em class="property"> = 44</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.BLUE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.CYAN">
+<tt class="descname">CYAN</tt><em class="property"> = 46</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.CYAN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.GREEN">
+<tt class="descname">GREEN</tt><em class="property"> = 42</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.GREEN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTBLACK_EX">
+<tt class="descname">LIGHTBLACK_EX</tt><em class="property"> = 100</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTBLACK_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTBLUE_EX">
+<tt class="descname">LIGHTBLUE_EX</tt><em class="property"> = 104</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTBLUE_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTCYAN_EX">
+<tt class="descname">LIGHTCYAN_EX</tt><em class="property"> = 106</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTCYAN_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTGREEN_EX">
+<tt class="descname">LIGHTGREEN_EX</tt><em class="property"> = 102</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTGREEN_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX">
+<tt class="descname">LIGHTMAGENTA_EX</tt><em class="property"> = 105</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTRED_EX">
+<tt class="descname">LIGHTRED_EX</tt><em class="property"> = 101</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTRED_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTWHITE_EX">
+<tt class="descname">LIGHTWHITE_EX</tt><em class="property"> = 107</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTWHITE_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX">
+<tt class="descname">LIGHTYELLOW_EX</tt><em class="property"> = 103</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.MAGENTA">
+<tt class="descname">MAGENTA</tt><em class="property"> = 45</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.MAGENTA" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.RED">
+<tt class="descname">RED</tt><em class="property"> = 41</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.RED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.RESET">
+<tt class="descname">RESET</tt><em class="property"> = 49</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.RESET" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.WHITE">
+<tt class="descname">WHITE</tt><em class="property"> = 47</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.WHITE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiBack.YELLOW">
+<tt class="descname">YELLOW</tt><em class="property"> = 43</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.YELLOW" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.ansi.AnsiCodes">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">AnsiCodes</tt><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCodes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.ansi.AnsiCursor">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">AnsiCursor</tt><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<dl class="method">
+<dt id="src.colorama.ansi.AnsiCursor.BACK">
+<tt class="descname">BACK</tt><big>(</big><em>n=1</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.BACK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.BACK" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansi.AnsiCursor.DOWN">
+<tt class="descname">DOWN</tt><big>(</big><em>n=1</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.DOWN"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.DOWN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansi.AnsiCursor.FORWARD">
+<tt class="descname">FORWARD</tt><big>(</big><em>n=1</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.FORWARD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.FORWARD" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansi.AnsiCursor.POS">
+<tt class="descname">POS</tt><big>(</big><em>x=1</em>, <em>y=1</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.POS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.POS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansi.AnsiCursor.UP">
+<tt class="descname">UP</tt><big>(</big><em>n=1</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.UP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.UP" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.ansi.AnsiFore">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">AnsiFore</tt><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiFore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiFore" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><tt class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></tt></a></p>
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.BLACK">
+<tt class="descname">BLACK</tt><em class="property"> = 30</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.BLACK" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.BLUE">
+<tt class="descname">BLUE</tt><em class="property"> = 34</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.BLUE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.CYAN">
+<tt class="descname">CYAN</tt><em class="property"> = 36</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.CYAN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.GREEN">
+<tt class="descname">GREEN</tt><em class="property"> = 32</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.GREEN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTBLACK_EX">
+<tt class="descname">LIGHTBLACK_EX</tt><em class="property"> = 90</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTBLACK_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTBLUE_EX">
+<tt class="descname">LIGHTBLUE_EX</tt><em class="property"> = 94</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTBLUE_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTCYAN_EX">
+<tt class="descname">LIGHTCYAN_EX</tt><em class="property"> = 96</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTCYAN_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTGREEN_EX">
+<tt class="descname">LIGHTGREEN_EX</tt><em class="property"> = 92</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTGREEN_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX">
+<tt class="descname">LIGHTMAGENTA_EX</tt><em class="property"> = 95</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTRED_EX">
+<tt class="descname">LIGHTRED_EX</tt><em class="property"> = 91</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTRED_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTWHITE_EX">
+<tt class="descname">LIGHTWHITE_EX</tt><em class="property"> = 97</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTWHITE_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX">
+<tt class="descname">LIGHTYELLOW_EX</tt><em class="property"> = 93</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.MAGENTA">
+<tt class="descname">MAGENTA</tt><em class="property"> = 35</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.MAGENTA" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.RED">
+<tt class="descname">RED</tt><em class="property"> = 31</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.RED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.RESET">
+<tt class="descname">RESET</tt><em class="property"> = 39</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.RESET" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.WHITE">
+<tt class="descname">WHITE</tt><em class="property"> = 37</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.WHITE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiFore.YELLOW">
+<tt class="descname">YELLOW</tt><em class="property"> = 33</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.YELLOW" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.ansi.AnsiStyle">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">AnsiStyle</tt><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiStyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiStyle" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><tt class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></tt></a></p>
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiStyle.BRIGHT">
+<tt class="descname">BRIGHT</tt><em class="property"> = 1</em><a class="headerlink" href="#src.colorama.ansi.AnsiStyle.BRIGHT" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiStyle.DIM">
+<tt class="descname">DIM</tt><em class="property"> = 2</em><a class="headerlink" href="#src.colorama.ansi.AnsiStyle.DIM" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiStyle.NORMAL">
+<tt class="descname">NORMAL</tt><em class="property"> = 22</em><a class="headerlink" href="#src.colorama.ansi.AnsiStyle.NORMAL" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansi.AnsiStyle.RESET_ALL">
+<tt class="descname">RESET_ALL</tt><em class="property"> = 0</em><a class="headerlink" href="#src.colorama.ansi.AnsiStyle.RESET_ALL" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansi.clear_line">
+<tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">clear_line</tt><big>(</big><em>mode=2</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#clear_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.clear_line" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansi.clear_screen">
+<tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">clear_screen</tt><big>(</big><em>mode=2</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#clear_screen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.clear_screen" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansi.code_to_chars">
+<tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">code_to_chars</tt><big>(</big><em>code</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#code_to_chars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.code_to_chars" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansi.set_title">
+<tt class="descclassname">src.colorama.ansi.</tt><tt class="descname">set_title</tt><big>(</big><em>title</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansi.html#set_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.set_title" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.colorama.ansitowin32">
+<span id="ansitowin32-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ansitowin32</span></tt> Module<a class="headerlink" href="#module-src.colorama.ansitowin32" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="src.colorama.ansitowin32.AnsiToWin32">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansitowin32.</tt><tt class="descname">AnsiToWin32</tt><big>(</big><em>wrapped</em>, <em>convert=None</em>, <em>strip=None</em>, <em>autoreset=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Implements a 'write()' method which, on Windows, will strip ANSI character
+sequences from the text, and if outputting to a tty, will convert them into
+win32 function calls.</p>
+<dl class="attribute">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">
+<tt class="descname">ANSI_CSI_RE</tt><em class="property"> = <_sre.SRE_Pattern object at 0x3ff4610></em><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE">
+<tt class="descname">ANSI_OSC_RE</tt><em class="property"> = <_sre.SRE_Pattern object at 0x42d2cf0></em><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.call_win32">
+<tt class="descname">call_win32</tt><big>(</big><em>command</em>, <em>params</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.call_win32"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.call_win32" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.convert_ansi">
+<tt class="descname">convert_ansi</tt><big>(</big><em>paramstring</em>, <em>command</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.convert_ansi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.convert_ansi" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.convert_osc">
+<tt class="descname">convert_osc</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.convert_osc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.convert_osc" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.extract_params">
+<tt class="descname">extract_params</tt><big>(</big><em>command</em>, <em>paramstring</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.extract_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.extract_params" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.get_win32_calls">
+<tt class="descname">get_win32_calls</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.get_win32_calls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.get_win32_calls" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.reset_all">
+<tt class="descname">reset_all</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.reset_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.reset_all" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.should_wrap">
+<tt class="descname">should_wrap</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.should_wrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.should_wrap" title="Permalink to this definition">¶</a></dt>
+<dd><p>True if this class is actually needed. If false, then the output
+stream will not be affected, nor will win32 calls be issued, so
+wrapping stdout is not actually required. This will generally be
+False on non-Windows platforms, unless optional functionality like
+autoreset has been requested using kwargs to init()</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.write">
+<tt class="descname">write</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.write_and_convert">
+<tt class="descname">write_and_convert</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.write_and_convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.write_and_convert" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write the given text to our wrapped stream, stripping any ANSI
+sequences from the text, and optionally converting them into win32
+calls.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.ansitowin32.AnsiToWin32.write_plain_text">
+<tt class="descname">write_plain_text</tt><big>(</big><em>text</em>, <em>start</em>, <em>end</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#AnsiToWin32.write_plain_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.write_plain_text" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.ansitowin32.StreamWrapper">
+<em class="property">class </em><tt class="descclassname">src.colorama.ansitowin32.</tt><tt class="descname">StreamWrapper</tt><big>(</big><em>wrapped</em>, <em>converter</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#StreamWrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.StreamWrapper" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Wraps a stream (such as stdout), acting as a transparent proxy for all
+attribute access apart from method 'write()', which is delegated to our
+Converter instance.</p>
+<dl class="method">
+<dt id="src.colorama.ansitowin32.StreamWrapper.write">
+<tt class="descname">write</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#StreamWrapper.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.StreamWrapper.write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansitowin32.is_a_tty">
+<tt class="descclassname">src.colorama.ansitowin32.</tt><tt class="descname">is_a_tty</tt><big>(</big><em>stream</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#is_a_tty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.is_a_tty" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.ansitowin32.is_stream_closed">
+<tt class="descclassname">src.colorama.ansitowin32.</tt><tt class="descname">is_stream_closed</tt><big>(</big><em>stream</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#is_stream_closed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.is_stream_closed" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.colorama.initialise">
+<span id="initialise-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">initialise</span></tt> Module<a class="headerlink" href="#module-src.colorama.initialise" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="src.colorama.initialise.colorama_text">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">colorama_text</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#colorama_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.colorama_text" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.initialise.deinit">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">deinit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#deinit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.deinit" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.initialise.init">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">init</tt><big>(</big><em>autoreset=False</em>, <em>convert=None</em>, <em>strip=None</em>, <em>wrap=True</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.init" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.initialise.reinit">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">reinit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#reinit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.reinit" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.initialise.reset_all">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">reset_all</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#reset_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.reset_all" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.initialise.wrap_stream">
+<tt class="descclassname">src.colorama.initialise.</tt><tt class="descname">wrap_stream</tt><big>(</big><em>stream</em>, <em>convert</em>, <em>strip</em>, <em>autoreset</em>, <em>wrap</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/initialise.html#wrap_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.initialise.wrap_stream" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.colorama.win32">
+<span id="win32-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">win32</span></tt> Module<a class="headerlink" href="#module-src.colorama.win32" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="src.colorama.win32.SetConsoleTextAttribute">
+<tt class="descclassname">src.colorama.win32.</tt><tt class="descname">SetConsoleTextAttribute</tt><big>(</big><em>*_</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/win32.html#SetConsoleTextAttribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.win32.SetConsoleTextAttribute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.colorama.win32.winapi_test">
+<tt class="descclassname">src.colorama.win32.</tt><tt class="descname">winapi_test</tt><big>(</big><em>*_</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/win32.html#winapi_test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.win32.winapi_test" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.colorama.winterm">
+<span id="winterm-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">winterm</span></tt> Module<a class="headerlink" href="#module-src.colorama.winterm" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="src.colorama.winterm.WinColor">
+<em class="property">class </em><tt class="descclassname">src.colorama.winterm.</tt><tt class="descname">WinColor</tt><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinColor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinColor" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.BLACK">
+<tt class="descname">BLACK</tt><em class="property"> = 0</em><a class="headerlink" href="#src.colorama.winterm.WinColor.BLACK" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.BLUE">
+<tt class="descname">BLUE</tt><em class="property"> = 1</em><a class="headerlink" href="#src.colorama.winterm.WinColor.BLUE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.CYAN">
+<tt class="descname">CYAN</tt><em class="property"> = 3</em><a class="headerlink" href="#src.colorama.winterm.WinColor.CYAN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.GREEN">
+<tt class="descname">GREEN</tt><em class="property"> = 2</em><a class="headerlink" href="#src.colorama.winterm.WinColor.GREEN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.GREY">
+<tt class="descname">GREY</tt><em class="property"> = 7</em><a class="headerlink" href="#src.colorama.winterm.WinColor.GREY" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.MAGENTA">
+<tt class="descname">MAGENTA</tt><em class="property"> = 5</em><a class="headerlink" href="#src.colorama.winterm.WinColor.MAGENTA" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.RED">
+<tt class="descname">RED</tt><em class="property"> = 4</em><a class="headerlink" href="#src.colorama.winterm.WinColor.RED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinColor.YELLOW">
+<tt class="descname">YELLOW</tt><em class="property"> = 6</em><a class="headerlink" href="#src.colorama.winterm.WinColor.YELLOW" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.winterm.WinStyle">
+<em class="property">class </em><tt class="descclassname">src.colorama.winterm.</tt><tt class="descname">WinStyle</tt><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinStyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinStyle" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinStyle.BRIGHT">
+<tt class="descname">BRIGHT</tt><em class="property"> = 8</em><a class="headerlink" href="#src.colorama.winterm.WinStyle.BRIGHT" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND">
+<tt class="descname">BRIGHT_BACKGROUND</tt><em class="property"> = 128</em><a class="headerlink" href="#src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.colorama.winterm.WinStyle.NORMAL">
+<tt class="descname">NORMAL</tt><em class="property"> = 0</em><a class="headerlink" href="#src.colorama.winterm.WinStyle.NORMAL" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.colorama.winterm.WinTerm">
+<em class="property">class </em><tt class="descclassname">src.colorama.winterm.</tt><tt class="descname">WinTerm</tt><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.back">
+<tt class="descname">back</tt><big>(</big><em>back=None</em>, <em>light=False</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.back" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.cursor_adjust">
+<tt class="descname">cursor_adjust</tt><big>(</big><em>x</em>, <em>y</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.cursor_adjust"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.cursor_adjust" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.erase_line">
+<tt class="descname">erase_line</tt><big>(</big><em>mode=0</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.erase_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.erase_line" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.erase_screen">
+<tt class="descname">erase_screen</tt><big>(</big><em>mode=0</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.erase_screen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.erase_screen" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.fore">
+<tt class="descname">fore</tt><big>(</big><em>fore=None</em>, <em>light=False</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.fore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.fore" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.get_attrs">
+<tt class="descname">get_attrs</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.get_attrs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.get_attrs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.get_position">
+<tt class="descname">get_position</tt><big>(</big><em>handle</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.get_position"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.get_position" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.reset_all">
+<tt class="descname">reset_all</tt><big>(</big><em>on_stderr=None</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.reset_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.reset_all" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.set_attrs">
+<tt class="descname">set_attrs</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.set_attrs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.set_attrs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.set_console">
+<tt class="descname">set_console</tt><big>(</big><em>attrs=None</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.set_console"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.set_console" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.set_cursor_position">
+<tt class="descname">set_cursor_position</tt><big>(</big><em>position=None</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.set_cursor_position"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.set_cursor_position" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.set_title">
+<tt class="descname">set_title</tt><big>(</big><em>title</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.set_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.set_title" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.colorama.winterm.WinTerm.style">
+<tt class="descname">style</tt><big>(</big><em>style=None</em>, <em>on_stderr=False</em><big>)</big><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.style"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.style" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">colorama Package</a><ul>
+<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">colorama</span></tt> Package</a></li>
+<li><a class="reference internal" href="#module-src.colorama.ansi"><tt class="docutils literal"><span class="pre">ansi</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.ansitowin32"><tt class="docutils literal"><span class="pre">ansitowin32</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.initialise"><tt class="docutils literal"><span class="pre">initialise</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.win32"><tt class="docutils literal"><span class="pre">win32</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.winterm"><tt class="docutils literal"><span class="pre">winterm</span></tt> Module</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="modules.html">src</a><ul>
+ <li><a href="src.html">src Package</a><ul>
+ <li>Previous: <a href="src.html" title="previous chapter">src Package</a></li>
+ <li>Next: <a href="../../release_notes/release_notes_5.0.0.html" title="next chapter">Release notes</a></li>
+ </ul></li>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../../_sources/commands/apidoc/src.colorama.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../../_sources/commands/apidoc/src.colorama.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src Package — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="src" href="modules.html" />
+ <link rel="next" title="colorama Package" href="src.colorama.html" />
+ <link rel="prev" title="src" href="modules.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="src-package">
+<h1>src Package<a class="headerlink" href="#src-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="id1">
+<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>
+<span class="target" id="module-src.__init__"></span><p>initial imports and utilities methods for salomeTools</p>
+<dl class="class">
+<dt id="src.__init__.Path">
+<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>
+<dd><dl class="method">
+<dt id="src.__init__.Path.base">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.chmod">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.copy">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.copydir">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.copyfile">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.copylink">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.dir">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.exists">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.isdir">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.isfile">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.islink">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.list">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.make">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.readlink">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.rm">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.smartcopy">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.__init__.Path.symlink">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="exception">
+<dt id="src.__init__.SatException">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
+<p>rename Exception Class</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.activate_mesa_property">
+<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>
+<dd><p>Add mesa property into application properties</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.check_config_has_application">
+<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>
+<dd><p>check that the config has the key APPLICATION. Else raise an exception.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.check_config_has_profile">
+<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>
+<dd><p>check that the config has the key APPLICATION.profile.
+else, raise an exception.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.config_has_application">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.deepcopy_list">
+<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>
+<dd><p>Do a deep copy of a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The copy of the list</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.ensure_path_exists">
+<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>
+<dd><p>Create a path if not existing</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>p</em>) -- The path.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.find_file_in_lpath">
+<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>
+<dd><p>Find in all the directories in lpath list the file that has the same name
+as file_name.
+If it is found
+then return the full path of the file
+else return False.</p>
+<p>The additional_dir (optional) is the name of the directory to add to all
+paths in lpath.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>additional_dir</em>) -- The file name to search</li>
+<li><strong>List</strong> (<em>lpath</em>) -- The list of directories where to search</li>
+<li><strong>str</strong> -- The name of the additional directory</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_base_path">
+<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>
+<dd><p>Returns the path of the products base.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the products base.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_cfg_param">
+<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>
+<dd><p>eearch for param_name value in config.
+if param_name is not in config
+then return default,
+else return the found value</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) -- The config.</li>
+<li><strong>str</strong> (<em>default</em>) -- the name of the parameter to get the value</li>
+<li><strong>str</strong> -- The value to return if param_name is not in config</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_launcher_name">
+<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>
+<dd><p>Returns the name of salome launcher.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of salome launcher.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_log_path">
+<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>
+<dd><p>Returns the path of the logs.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logs.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_property_in_product_cfg">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_salome_version">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.get_tmp_filename">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.handleRemoveReadonly">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.merge_dicts">
+<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>
+<dd><p>Given any number of dicts, shallow copy and merge into a new dict,
+precedence goes to key value pairs in latter dicts.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.only_numbers">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.parse_date">
+<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>
+<dd><p>Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The date in the new format</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.print_info">
+<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>
+<dd><p>Prints the tuples that are in info variable in a formatted way.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Logger</strong> (<em>logger</em>) -- The logging instance to use for the prints.</li>
+<li><strong>list</strong> (<em>info</em>) -- The list of tuples to display</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.read_config_from_a_file">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.remove_item_from_list">
+<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>
+<dd><p>Remove all occurences of item from input_list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The without any item</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.__init__.replace_in_file">
+<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>
+<dd><p>Replace <strin> by <strout> in file <filein></p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.ElementTree">
+<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>
+<dl class="function">
+<dt id="src.ElementTree.Comment">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.dump">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.Element">
+<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>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.ElementTree">
+<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>
+<dd><dl class="method">
+<dt id="src.ElementTree.ElementTree.find">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.findall">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.findtext">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.getiterator">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.getroot">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.parse">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.ElementTree.write">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.fromstring">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.iselement">
+<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>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.iterparse">
+<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>
+<dd><dl class="method">
+<dt id="src.ElementTree.iterparse.next">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.parse">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.PI">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.ProcessingInstruction">
+<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>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.QName">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.SubElement">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.tostring">
+<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>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.TreeBuilder">
+<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>
+<dd><dl class="method">
+<dt id="src.ElementTree.TreeBuilder.close">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.TreeBuilder.data">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.TreeBuilder.end">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.TreeBuilder.start">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.XML">
+<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>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.XMLTreeBuilder">
+<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>
+<dd><dl class="method">
+<dt id="src.ElementTree.XMLTreeBuilder.close">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.XMLTreeBuilder.doctype">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.ElementTree.XMLTreeBuilder.feed">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.architecture">
+<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>
+<p>In this file : all the stuff that can change with the architecture
+on which SAT is running</p>
+<dl class="function">
+<dt id="src.architecture.get_distrib_version">
+<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>
+<dd><p>Gets the version of the distribution</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>distrib</em>) -- The distribution on which the version will be found.</li>
+<li><strong>L{Mapping}</strong> (<em>codes</em>) -- The map containing distribution correlation table.</li>
+</ul>
+</td>
+</tr>
+<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,
+regarding the distribution correlation table contained in codes
+variable.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.architecture.get_distribution">
+<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>
+<dd><p>Gets the code for the distribution</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The distribution on which salomeTools is running, regarding the
+distribution correlation table contained in codes variable.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.architecture.get_nb_proc">
+<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>
+<dd><p>Gets the number of processors of the machine
+on which salomeTools is running.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processors.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.architecture.get_python_version">
+<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>
+<dd><p>Gets the version of the running python.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the version of the running python.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.architecture.get_user">
+<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>
+<dd><p>method that gets the username that launched sat</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.architecture.is_windows">
+<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>
+<dd><p>method that checks windows OS</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.compilation">
+<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>
+<dl class="class">
+<dt id="src.compilation.Builder">
+<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=<src.options.OptResult object at 0x245afd0></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>
+<dd><p>Class to handle all construction steps, like cmake, configure, make, ...</p>
+<dl class="method">
+<dt id="src.compilation.Builder.build_configure">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.check">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.cmake">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.complete_environment">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.configure">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.do_batch_script_build">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.do_default_build">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.do_python_script_build">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.do_script_build">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.hack_libtool">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.install">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.log">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.log_command">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.make">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.prepare">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.put_txt_log_in_appli_log_dir">
+<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>
+<dd><p>Put the txt log (that contain the system logs, like make command
+output) in the directory <APPLICATION DIR>/LOGS/<product_name>/</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.compilation.Builder.wmake">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.debug">
+<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>
+<p>This file assume DEBUG functionalities use</p>
+<ul class="simple">
+<li>print debug messages in sys.stderr for salomeTools</li>
+<li>show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')</li>
+</ul>
+<p>WARNING: obviously supposedly show messages in SAT development phase, not production</p>
+<p>usage:
+>> import debug as DBG
+>> DBG.write("aTitle", aVariable) # not shown in production
+>> DBG.write("aTitle", aVariable, True) # unconditionaly shown (as show=True)</p>
+<p>to set show message as development phase:
+>> DBG.push_debug(True)</p>
+<p>to set no show message as production phase:
+>> DBG.push_debug(False)</p>
+<p>to set show message temporary as development phase, only in a method:
+>> def aMethodToDebug(...):
+>> DBG.push_debug(True) #force show as appended status
+>> etc. method code with some DBG.write()
+>> DBG.pop_debug() #restore previous status (show or not show)
+>> return</p>
+<p>to set a message for future fix, as temporary problem to not forget:
+DBG.tofix("aTitle", aVariable, True/False) #True/False in production shown, or not</p>
+<p>in command line interface you could redirect stderr to file 'myDebug.log':
+>> sat compile ... 2> myDebug.log # only stderr
+>> sat compile ... &> myDebug.log # stdout and stderr</p>
+<dl class="class">
+<dt id="src.debug.InStream">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></tt></p>
+<p>utility class for pyconf.Config input iostream</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.debug.OutStream">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></tt></p>
+<p>utility class for pyconf.Config output iostream</p>
+<dl class="method">
+<dt id="src.debug.OutStream.close">
+<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>
+<dd><p>because Config.__save__ calls close() stream as file
+keep value before lost as self.value</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.getLocalEnv">
+<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>
+<dd><p>get string for environment variables representation</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.getStrConfigDbg">
+<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>
+<dd><p>set string as saveConfigDbg,
+as (path expression evaluation) for debug</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.getStrConfigStd">
+<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>
+<dd><p>set string as saveConfigStd, as file .pyconf</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.indent">
+<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>
+<dd><p>indent multi lines message</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.pop_debug">
+<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>
+<dd><p>restore previous debug outputs status</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.push_debug">
+<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>
+<dd><p>set debug outputs activated, or not</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.saveConfigDbg">
+<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>
+<dd><p>pyconf returns multilines (path expression evaluation) for debug</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.saveConfigStd">
+<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>
+<dd><p>returns as file .pyconf</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.tofix">
+<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>
+<dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True
+use this only if no logger accessible for classic
+logger.warning(message) or logger.debug(message)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.debug.write">
+<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>
+<dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.environment">
+<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>
+<dl class="class">
+<dt id="src.environment.Environ">
+<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>
+<dd><p>Class to manage the environment context</p>
+<dl class="method">
+<dt id="src.environment.Environ.append">
+<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>
+<dd><p>Same as append_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.append_value">
+<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>
+<dd><p>append value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.is_defined">
+<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>
+<dd><p>Check if the key exists in the environment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.prepend">
+<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>
+<dd><p>Same as prepend_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.prepend_value">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.Environ.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.environment.FileEnvWriter">
+<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>
+<dd><p>Class to dump the environment to a file.</p>
+<dl class="method">
+<dt id="src.environment.FileEnvWriter.write_cfgForPy_file">
+<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>
+<dd><p>Append to current opened aFile a cfgForPy
+environment (SALOME python launcher).</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>for_package</em>) -- the file path</li>
+<li><strong>dict</strong> (<em>additional_env</em>) -- a dictionary of additional variables
+to add to the environment</li>
+<li><strong>str</strong> -- If not None, produce a relative environment
+designed for a package.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.FileEnvWriter.write_env_file">
+<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>
+<dd><p>Create an environment file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>shell</em>) -- the file path</li>
+<li><strong>bool</strong> (<em>forBuild</em>) -- if true, the build environment</li>
+<li><strong>str</strong> -- the type of file wanted (.sh, .bat)</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.environment.SalomeEnviron">
+<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>
+<dd><p>Class to manage the environment of SALOME.</p>
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.add_comment">
+<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>
+<dd><p>Add a commentary to the out stream (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.add_line">
+<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>
+<dd><p>Add empty lines to the out stream (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.add_warning">
+<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>
+<dd><p>Add a warning to the out stream (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.append">
+<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>
+<dd><p>append value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.dump">
+<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>
+<dd><p>Write the environment to out</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.get_names">
+<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>
+<dd><p>Get the products name to add in SALOME_MODULES environment variable
+It is the name of the product, except in the case where the is a
+component name. And it has to be in SALOME_MODULES variable only
+if the product has the property has_salome_hui = "yes"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.is_defined">
+<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>
+<dd><p>Check if the key exists in the environment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.load_cfg_environment">
+<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>
+<dd><p>Loads environment defined in cfg_env</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.prepend">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.run_env_script">
+<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>
+<dd><p>Runs an environment script.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>Boolean</strong> (<em>native</em>) -- if True load set_native_env instead of set_env</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.run_simple_env_script">
+<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>
+<dd><p>Runs an environment script. Same as run_env_script, but with a
+script path as parameter.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>script_path</em>) -- a path to an environment script</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_a_product">
+<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>
+<dd><p>Sets the environment of a product.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>product</em>) -- The product name</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_application_env">
+<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>
+<dd><p>Sets the environment defined in the APPLICATION file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_cpp_env">
+<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>
+<dd><p>Sets the generic environment for a SALOME cpp product.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_full_environ">
+<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>
+<dd><p>Sets the full environment for products
+specified in env_info dictionary.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>list</strong> (<em>env_info</em>) -- the list of products</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_products">
+<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>
+<dd><p>Sets the environment for all the products.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>src</strong> (<em>src_root</em>) -- the application working directory</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_python_libdirs">
+<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>
+<dd><p>Set some generic variables for python library paths</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_salome_generic_product_env">
+<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>
+<dd><p>Sets the generic environment for a SALOME product.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.environment.SalomeEnviron.set_salome_minimal_product_env">
+<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>
+<dd><p>Sets the minimal environment for a SALOME product.
+xxx_ROOT_DIR and xxx_SRC_DIR</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.environment.Shell">
+<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>
+<dd><p>Definition of a Shell.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.environment.load_environment">
+<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>
+<dd><p>Loads the environment (used to run the tests, for example).</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>config</em>) -- the global config</li>
+<li><strong>bool</strong> (<em>build</em>) -- build environement if True</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.fileEnviron">
+<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>
+<dl class="class">
+<dt id="src.fileEnviron.BashFileEnviron">
+<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>
+<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>
+<p>Class for bash shell.</p>
+<dl class="method">
+<dt id="src.fileEnviron.BashFileEnviron.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BashFileEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BashFileEnviron.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.fileEnviron.BatFileEnviron">
+<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>
+<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>
+<p>for Windows batch shell.</p>
+<dl class="method">
+<dt id="src.fileEnviron.BatFileEnviron.add_comment">
+<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>
+<dd><p>Add a comment in the shell file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BatFileEnviron.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BatFileEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)
+In the particular windows case, do nothing</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BatFileEnviron.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.BatFileEnviron.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.fileEnviron.ContextFileEnviron">
+<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>
+<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>
+<p>Class for a salome context configuration file.</p>
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.add_echo">
+<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>
+<dd><p>Add a comment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.add_warning">
+<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>
+<dd><p>Add a warning</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.append_value">
+<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>
+<dd><p>append value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.prepend_value">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ContextFileEnviron.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.fileEnviron.FileEnviron">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Base class for shell environment</p>
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.add_comment">
+<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>
+<dd><p>Add a comment in the shell file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.add_echo">
+<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>
+<dd><p>Add a "echo" in the shell file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.add_line">
+<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>
+<dd><p>Add some empty lines in the shell file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.add_warning">
+<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>
+<dd><p>Add a warning "echo" in the shell file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.append">
+<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>
+<dd><p>Same as append_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.append_value">
+<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>
+<dd><p>append value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.is_defined">
+<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>
+<dd><p>Check if the key exists in the environment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.prepend">
+<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>
+<dd><p>Same as prepend_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.prepend_value">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.FileEnviron.set">
+<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>
+<dd><p>Set the environment variable 'key' to value 'value'</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.fileEnviron.LauncherFileEnviron">
+<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>
+<dd><p>Class to generate a launcher file script
+(in python syntax) SalomeContext API</p>
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.add">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.add_comment">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.add_echo">
+<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>
+<dd><p>Add a comment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.add_line">
+<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>
+<dd><p>Add some empty lines in the launcher file</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.add_warning">
+<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>
+<dd><p>Add a warning</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.append">
+<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>
+<dd><p>Same as append_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.append_value">
+<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>
+<dd><p>append value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.change_to_launcher">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.command_value">
+<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>
+<dd><p>Get the value given by the system command "command"
+and put it in the environment variable key.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.finish">
+<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>
+<dd><p>Add a final instruction in the out file (in case of file generation)
+In the particular launcher case, do nothing</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.get">
+<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>
+<dd><p>Get the value of the environment variable "key"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.is_defined">
+<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>
+<dd><p>Check if the key exists in the environment</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.prepend">
+<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>
+<dd><p>Same as prepend_value but the value argument can be a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.prepend_value">
+<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>
+<dd><p>prepend value to key using sep</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.LauncherFileEnviron.set">
+<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>
+<dd><p>Set the environment variable "key" to value "value"</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.fileEnviron.ScreenEnviron">
+<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>
+<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>
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.add_comment">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.add_echo">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.add_line">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.add_warning">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.append">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.command_value">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.get">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.is_defined">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.prepend">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.run_env_script">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.set">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.fileEnviron.ScreenEnviron.write">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.fileEnviron.get_file_environ">
+<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>
+<dd><p>Instantiate correct FileEnvironment sub-class.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>file</strong> (<em>output</em>) -- the output file stream.</li>
+<li><strong>str</strong> (<em>shell</em>) -- the type of shell syntax to use.</li>
+<li><strong>dict</strong> (<em>environ</em>) -- a potential additional environment.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.fileEnviron.special_path_separator">
+<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>
+<dd><p>TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need
+some exotic path separator.
+This function gives the separator regarding the name of the variable
+to append or prepend.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.fork">
+<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>
+<dl class="function">
+<dt id="src.fork.batch">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.fork.batch_salome">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.fork.launch_command">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.fork.show_progress">
+<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>
+<dd><p>shortcut function to display the progression</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
+<li><strong>int</strong> (<em>delai</em>) -- the number to display</li>
+<li><strong>int</strong> -- the number max</li>
+<li><strong>str</strong> (<em>ss</em>) -- the string to display</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.fork.write_back">
+<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>
+<dd><p>shortcut function to write at the begin of the line</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
+<li><strong>str</strong> (<em>message</em>) -- the text to display</li>
+<li><strong>int</strong> (<em>level</em>) -- the level of verbosity</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.logger">
+<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>
+<p>Implements the classes and method relative to the logging</p>
+<dl class="class">
+<dt id="src.logger.Logger">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Class to handle log mechanism.</p>
+<dl class="method">
+<dt id="src.logger.Logger.add_link">
+<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>
+<dd><p>Add a link to another log file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>command_res</em>) -- The file name of the link.</li>
+<li><strong>str</strong> -- The name of the command linked.</li>
+<li><strong>str</strong> -- The result of the command linked. "0" or "1"</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">Parma full_launched_command str:</th></tr>
+<tr class="field-even field"><td> </td><td class="field-body"><p class="first last">The full lanch command
+("sat command ...")</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.logger.Logger.end_write">
+<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>
+<dd><p>Called just after command end: Put all fields
+corresponding to the command end context (time).
+Write the log xml file on the hard drive.
+And display the command to launch to get the log</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dict</strong> (<em>attribute</em>) -- the attribute to add to the node "Site".</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.logger.Logger.error">
+<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>
+<dd><p>Print an error.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.logger.Logger.flush">
+<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>
+<dd><p>Flush terminal</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.logger.Logger.put_initial_xml_fields">
+<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>
+<dd><p>Called at class initialization: Put all fields
+corresponding to the command context (user, time, ...)</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.logger.Logger.write">
+<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>
+<dd><p>function used in the commands
+to print in the terminal and the log file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>message</em>) -- The message to print.</li>
+<li><strong>int</strong> (<em>level</em>) -- The output level corresponding
+to the message 0 < level < 6.</li>
+<li><strong>boolean</strong> (<em>screenOnly</em>) -- if True, do not write in log file.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.logger.date_to_datetime">
+<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>
+<dd><p>From a string date in format YYYYMMDD_HHMMSS
+returns list year, mon, day, hour, minutes, seconds</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the same date and time in separate variables.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(str,str,str,str,str,str)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.logger.list_log_file">
+<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>
+<dd><p>Find all files corresponding to expression in dirPath</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>expression</em>) -- the directory where to search the files</li>
+<li><strong>str</strong> -- the regular expression of files to find</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.logger.show_command_log">
+<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>
+<dd><p>Used in updateHatXml.
+Determine if the log xml file logFilePath
+has to be shown or not in the hat log.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>application</em>) -- the path to the command xml log file</li>
+<li><strong>str</strong> -- the command of the log file</li>
+<li><strong>str</strong> -- the application passed as parameter
+to the salomeTools command</li>
+<li><strong>list</strong> (<em>notShownCommands</em>) -- the list of commands
+that are not shown by default</li>
+</ul>
+</td>
+</tr>
+<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
+in the log file corresponds to application</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.logger.timedelta_total_seconds">
+<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>
+<dd><p>Replace total_seconds from datetime module
+in order to be compatible with old python versions</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of seconds corresponding to timedelta.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.logger.update_hat_xml">
+<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>
+<dd><p>Create the xml file in logDir that contain all the xml file
+and have a name like YYYYMMDD_HHMMSS_namecmd.xml</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>application</em>) -- the directory to parse</li>
+<li><strong>str</strong> -- the name of the application if there is any</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.options">
+<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>
+<p>The Options class that manages the access to all options passed as
+parameters in salomeTools command lines</p>
+<dl class="class">
+<dt id="src.options.OptResult">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>An instance of this class will be the object manipulated
+in code of all salomeTools commands
+The aim of this class is to have an elegant syntax
+to manipulate the options.
+ex:
+print(options.level)
+5</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.options.Options">
+<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>
+<dd><p>Class to manage all salomeTools options</p>
+<dl class="method">
+<dt id="src.options.Options.add_option">
+<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>
+<dd><p>Method to add an option to a command. It gets all attributes
+of an option and append it in the options field</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>helpString</em>) -- The short name of the option
+(ex "l" for level option).</li>
+<li><strong>str</strong> -- The long name of the option
+(ex "level" for level option).</li>
+<li><strong>str</strong> -- The type of the option (ex "int").</li>
+<li><strong>str</strong> -- The name that will be used in the code.</li>
+<li><strong>str</strong> -- The text to display
+when user ask for help on a command.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nothing.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">NA</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.parse_args">
+<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>
+<dd><p>Method that instantiates the class OptResult
+that gives access to all options in the code</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">optResult, args : optResult is the option instance
+to manipulate in the code. args
+is the full raw list of passed options</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(class 'common.options.OptResult',list)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.print_help">
+<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>
+<dd><p>Method that display all options stored in self.options and there help</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Nothing.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">NA</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.printcolors">
+<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>
+<p>In this file is stored the mechanism that manage color prints in the terminal</p>
+<dl class="function">
+<dt id="src.printcolors.cleancolor">
+<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>
+<dd><p>remove color from a colored text.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The cleaned text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.print_color_map">
+<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>
+<dd><p>This method prints the color map</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.print_color_range">
+<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>
+<dd><p>print possible range values for colors</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>int</strong> (<em>end</em>) -- The smaller value.</li>
+<li><strong>int</strong> -- The bigger value.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.print_value">
+<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>
+<dd><p>shortcut method to print a label and a value with the info color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>class logger</strong> (<em>logger</em>) -- the logger instance.</li>
+<li><strong>int</strong> (<em>level</em>) -- the label to print.</li>
+<li><strong>str</strong> (<em>suffix</em>) -- the value to print.</li>
+<li><strong>int</strong> -- the level of verboseness.</li>
+<li><strong>str</strong> -- the suffix to add at the end.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printc">
+<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>
+<dd><p>print a text with colors</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>code</em>) -- The text to be printed.</li>
+<li><strong>str</strong> -- The color to use.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The colored text.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcError">
+<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>
+<dd><p>print a text error color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcHeader">
+<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>
+<dd><p>print a text header color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcHighlight">
+<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>
+<dd><p>print a text highlight color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcInfo">
+<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>
+<dd><p>print a text info color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcLabel">
+<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>
+<dd><p>print a text label color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcSuccess">
+<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>
+<dd><p>print a text success color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.printcolors.printcWarning">
+<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>
+<dd><p>print a text warning color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.product">
+<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>
+<p>In this file are implemented the methods
+relative to the product notion of salomeTools</p>
+<dl class="function">
+<dt id="src.product.check_config_exists">
+<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>
+<dd><p>Verify that the installation directory of a product in a base exists
+Check all the config-<i> directory and verify the sat-config.pyconf file
+that is in it</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>prod_dir</em>) -- The product installation directory path
+(without config-<i>)</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
+</ul>
+</td>
+</tr>
+<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
+and if it is found, the path of the found installation</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(boolean, str)</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.check_installation">
+<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>
+<dd><p>Verify if a product is well installed. Checks install directory presence
+and some additional files if it is defined in the config</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.check_source">
+<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>
+<dd><p>Verify if a sources of product is preset. Checks source directory presence</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_base_install_dir">
+<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>
+<dd><p>Compute the installation directory of a product in base</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
+<li><strong>str</strong> (<em>version</em>) -- The version of the product</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_install_dir">
+<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>
+<dd><p>Compute the installation directory of a given product</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>version</em>) -- This corresponds to the value given by user in its
+application.pyconf for the specific product. If "yes", the
+user wants the product to be in base. If "no", he wants the
+product to be in the application workdir</li>
+<li><strong>str</strong> -- The version of the product</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_product_components">
+<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>
+<dd><p>Get the component list to generate with the product</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The list of names of the components</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_product_config">
+<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>
+<dd><p>Get the specific configuration of a product from the global configuration</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>product_name</em>) -- The name of the product</li>
+<li><strong>boolean</strong> (<em>with_install_dir</em>) -- If false, do not provide an install
+directory (at false only for internal use
+of the function check_config_exists)</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Config</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_product_dependencies">
+<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>
+<dd><p>Get recursively the list of products that are
+in the product_info dependencies</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_product_section">
+<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>
+<dd><p>Get the product description from the configuration</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>section</em>) -- The product name</li>
+<li><strong>str</strong> -- The version of the product</li>
+<li><strong>str</strong> -- The searched section (if not None, the section is
+explicitly given</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The product description</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Config</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.get_products_infos">
+<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>
+<dd><p>Get the specific configuration of a list of products</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>List</strong> (<em>lproducts</em>) -- The list of product names</li>
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of tuples
+(product name, specific configuration of the product)</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[(str, Config)]</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_compiles">
+<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>
+<dd><p>Know if a product compiles or not
+(some products do not have a compilation procedure)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product compiles, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_has_env_script">
+<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>
+<dd><p>Know if a product has an environment script</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_has_logo">
+<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>
+<dd><p>Know if a product has a logo (YACSGEN generate)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_has_patches">
+<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>
+<dd><p>Know if a product has one or more patches</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_has_salome_gui">
+<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>
+<dd><p>Know if a product has a SALOME gui</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_has_script">
+<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>
+<dd><p>Know if a product has a compilation script</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_autotools">
+<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>
+<dd><p>Know if a product is compiled using the autotools</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is autotools, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_cmake">
+<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>
+<dd><p>Know if a product is compiled using the cmake</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is cmake, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_cpp">
+<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>
+<dd><p>Know if a product is cpp</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_debug">
+<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>
+<dd><p>Know if a product is in debug mode</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_dev">
+<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>
+<dd><p>Know if a product is in dev mode</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_fixed">
+<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>
+<dd><p>Know if a product is fixed</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is fixed, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_generated">
+<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>
+<dd><p>Know if a product is generated (YACSGEN)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is generated</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_mpi">
+<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>
+<dd><p>Know if a product has openmpi in its dependencies</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has openmpi inits dependencies</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_native">
+<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>
+<dd><p>Know if a product is native</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is native, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_salome">
+<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>
+<dd><p>Know if a product is a SALOME module</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_sample">
+<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>
+<dd><p>Know if a product has the sample type</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_smesh_plugin">
+<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>
+<dd><p>Know if a product is a SMESH plugin</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.product.product_is_vcs">
+<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>
+<dd><p>Know if a product is download using git, svn or cvs (not archive)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is vcs, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.pyconf">
+<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>
+<p>This is a configuration module for Python.</p>
+<p>This module should work under Python versions >= 2.2, and cannot be used with
+earlier versions since it uses new-style classes.</p>
+<p>Development and testing has only been carried out (so far) on Python 2.3.4 and
+Python 2.4.2. See the test module (test_config.py) included in the
+U{distribution<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} (follow the
+download link).</p>
+<p>A simple example - with the example configuration file:</p>
+<div class="highlight-python"><pre>messages:
+[
+ {
+ stream : `sys.stderr`
+ message: 'Welcome'
+ name: 'Harry'
+ }
+ {
+ stream : `sys.stdout`
+ message: 'Welkom'
+ name: 'Ruud'
+ }
+ {
+ stream : $messages[0].stream
+ message: 'Bienvenue'
+ name: Yves
+ }
+]</pre>
+</div>
+<p>a program to read the configuration would be:</p>
+<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>
+
+<span class="n">f</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="s">'simple.cfg'</span><span class="p">)</span>
+<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>
+<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>
+ <span class="n">s</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">'</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>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">print</span> <span class="o">>></span> <span class="n">m</span><span class="o">.</span><span class="n">stream</span><span class="p">,</span> <span class="n">s</span>
+ <span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">print</span> <span class="n">e</span>
+</pre></div>
+</div>
+<p>which, when run, would yield the console output:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">Welcome</span><span class="p">,</span> <span class="n">Harry</span>
+<span class="n">Welkom</span><span class="p">,</span> <span class="n">Ruud</span>
+<span class="n">Bienvenue</span><span class="p">,</span> <span class="n">Yves</span>
+</pre></div>
+</div>
+<p>See U{this tutorial<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} for more
+information.</p>
+<p>#modified for salomeTools
+@version: 0.3.7.1</p>
+<p>@author: Vinay Sajip</p>
+<p>@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</p>
+<p>@var streamOpener: The default stream opener. This is a factory function which
+takes a string (e.g. filename) and returns a stream suitable for reading. If
+unable to open the stream, an IOError exception should be thrown.</p>
+<p>The default value of this variable is L{defaultStreamOpener}. For an example
+of how it's used, see test_config.py (search for streamOpener).</p>
+<dl class="class">
+<dt id="src.pyconf.Config">
+<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>
+<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>
+<p>This class represents a configuration, and is the only one which clients
+need to interface to, under normal circumstances.</p>
+<dl class="class">
+<dt id="src.pyconf.Config.Namespace">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class is used for implementing default namespaces.</p>
+<p>An instance acts as a namespace.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Config.addNamespace">
+<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>
+<dd><p>Add a namespace to this configuration which can be used to evaluate
+(resolve) dotted-identifier expressions.
+@param ns: The namespace to be added.
+@type ns: A module or other namespace suitable for passing as an
+argument to vars().
+@param name: A name for the namespace, which, if specified, provides
+an additional level of indirection.
+@type name: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Config.getByPath">
+<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>
+<dd><p>Obtain a value in the configuration via its path.
+@param path: The path of the required value
+@type path: str
+@return the value at the specified path.
+@rtype: any
+@raise ConfigError: If the path is invalid</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Config.load">
+<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>
+<dd><p>Load the configuration from the specified stream. Multiple streams can
+be used to populate the same instance, as long as there are no
+clashing keys. The stream is closed.
+@param stream: A stream from which the configuration is read.
+@type stream: A read-only stream (file-like object).
+@raise ConfigError: if keys in the loaded configuration clash with
+existing keys.
+@raise ConfigFormatError: if there is a syntax error in the stream.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Config.removeNamespace">
+<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>
+<dd><p>Remove a namespace added with L{addNamespace}.
+@param ns: The namespace to be removed.
+@param name: The name which was specified when L{addNamespace} was
+called.
+@type name: str</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="exception">
+<dt id="src.pyconf.ConfigError">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
+<p>This is the base class of exceptions raised by this module.</p>
+</dd></dl>
+
+<dl class="exception">
+<dt id="src.pyconf.ConfigFormatError">
+<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>
+<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>
+<p>This is the base class of exceptions raised due to syntax errors in
+configurations.</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.ConfigInputStream">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>An input stream which can read either ANSI files with default encoding
+or Unicode files with BOMs.</p>
+<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.close">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.read">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.readline">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.ConfigList">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></p>
+<p>This class implements an ordered list of configurations and allows you
+to try getting the configuration from each entry in turn, returning
+the first successfully obtained value.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigList.getByPath">
+<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>
+<dd><p>Obtain a value from the first configuration in the list which defines
+it.</p>
+<p>@param path: The path of the value to retrieve.
+@type path: str
+@return: The value from the earliest configuration in the list which
+defines it.
+@rtype: any
+@raise ConfigError: If no configuration in the list has an entry with
+the specified path.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.ConfigMerger">
+<em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigMerger</tt><big>(</big><em>resolver=<function defaultMergeResolve at 0x2379de8></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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This class is used for merging two configurations. If a key exists in the
+merge operand but not the merge target, then the entry is copied from the
+merge operand to the merge target. If a key exists in both configurations,
+then a resolver (a callable) is called to decide how to handle the
+conflict.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.handleMismatch">
+<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>
+<dd><p>Handle a mismatch between two objects.</p>
+<p>@param obj1: The object to merge into.
+@type obj1: any
+@param obj2: The object to merge.
+@type obj2: any</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.merge">
+<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>
+<dd><p>Merge two configurations. The second configuration is unchanged,
+and the first is changed to reflect the results of the merge.</p>
+<p>@param merged: The configuration to merge into.
+@type merged: L{Config}.
+@param mergee: The configuration to merge.
+@type mergee: L{Config}.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.mergeMapping">
+<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>
+<dd><p>Merge two mappings recursively. The second mapping is unchanged,
+and the first is changed to reflect the results of the merge.</p>
+<p>@param map1: The mapping to merge into.
+@type map1: L{Mapping}.
+@param map2: The mapping to merge.
+@type map2: L{Mapping}.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.mergeSequence">
+<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>
+<dd><p>Merge two sequences. The second sequence is unchanged,
+and the first is changed to have the elements of the second
+appended to it.</p>
+<p>@param seq1: The sequence to merge into.
+@type seq1: L{Sequence}.
+@param seq2: The sequence to merge.
+@type seq2: L{Sequence}.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.overwriteKeys">
+<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>
+<dd><p>Renint variables. The second mapping is unchanged,
+and the first is changed depending the keys of the second mapping.
+@param map1: The mapping to reinit keys into.
+@type map1: L{Mapping}.
+@param map2: The mapping container reinit information.
+@type map2: L{Mapping}.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.ConfigOutputStream">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>An output stream which can write either ANSI files with default encoding
+or Unicode files with BOMs.</p>
+<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.close">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.flush">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.write">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.ConfigReader">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class implements a parser for configurations.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.getChar">
+<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>
+<dd><p>Get the next char from the stream. Update line and column numbers
+appropriately.</p>
+<p>@return: The next character from the stream.
+@rtype: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.getToken">
+<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>
+<dd><p>Get a token from the stream. String values are returned in a form
+where you need to eval() the returned value to get the actual
+string. The return value is (token_type, token_value).</p>
+<p>Multiline string tokenizing is thanks to David Janes (BlogMatrix)</p>
+<p>@return: The next token.
+@rtype: A token tuple.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.load">
+<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>
+<dd><p>Load the configuration from the specified stream.</p>
+<p>@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+@param parent: The parent of the configuration (to which this reader
+belongs) in the hierarchy. Specified when the configuration is
+included in another one.
+@type parent: A L{Container} instance.
+@param suffix: The suffix of this configuration in the parent
+configuration. Should be specified whenever the parent is not None.
+@raise ConfigError: If parent is specified but suffix is not.
+@raise ConfigFormatError: If there are syntax errors in the stream.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.location">
+<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>
+<dd><p>Return the current location (filename, line, column) in the stream
+as a string.</p>
+<p>Used when printing error messages,</p>
+<p>@return: A string representing a location in the stream being read.
+@rtype: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.match">
+<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>
+<dd><p>Ensure that the current token type matches the specified value, and
+advance to the next token.</p>
+<p>@param t: The token type to match.
+@type t: A valid token type.
+@return: The token which was last read from the stream before this
+function is called.
+@rtype: a token tuple - see L{getToken}.
+@raise ConfigFormatError: If the token does not match what's expected.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseFactor">
+<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>
+<dd><p>Parse a factor in an multiplicative expression (a * b, a / b, a % b)</p>
+<p>@return: the parsed factor
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseKeyValuePair">
+<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>
+<dd><p>Parse a key-value pair, and add it to the provided L{Mapping}.</p>
+<p>@param parent: The mapping to add entries to.
+@type parent: A L{Mapping} instance.
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseMapping">
+<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>
+<dd><p>Parse a mapping.</p>
+<p>@param parent: The container to which the mapping will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L{Mapping} instance representing the mapping.
+@rtype: L{Mapping}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseMappingBody">
+<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>
+<dd><p>Parse the internals of a mapping, and add entries to the provided
+L{Mapping}.</p>
+<p>@param parent: The mapping to add entries to.
+@type parent: A L{Mapping} instance.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseReference">
+<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>
+<dd><p>Parse a reference.</p>
+<p>@return: the parsed reference
+@rtype: L{Reference}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseScalar">
+<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>
+<dd><p>Parse a scalar - a terminal value such as a string or number, or
+an L{Expression} or L{Reference}.</p>
+<p>@return: the parsed scalar
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseSequence">
+<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>
+<dd><p>Parse a sequence.</p>
+<p>@param parent: The container to which the sequence will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L{Sequence} instance representing the sequence.
+@rtype: L{Sequence}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseSuffix">
+<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>
+<dd><p>Parse a reference suffix.</p>
+<p>@param ref: The reference of which this suffix is a part.
+@type ref: L{Reference}.
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseTerm">
+<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>
+<dd><p>Parse a term in an additive expression (a + b, a - b)</p>
+<p>@return: the parsed term
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseValue">
+<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>
+<dd><p>Parse a value.</p>
+<p>@param parent: The container to which the value will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: The value
+@rtype: any
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.setStream">
+<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>
+<dd><p>Set the stream to the specified value, and prepare to read from it.</p>
+<p>@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="exception">
+<dt id="src.pyconf.ConfigResolutionError">
+<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>
+<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>
+<p>This is the base class of exceptions raised due to semantic errors in
+configurations.</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Container">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class is the base class for mappings and sequences.</p>
+<p>@ivar path: A string which describes how to get
+to this instance from the root of the hierarchy.</p>
+<p>Example:</p>
+<div class="highlight-python"><pre>a.list.of[1].or['more'].elements</pre>
+</div>
+<dl class="method">
+<dt id="src.pyconf.Container.evaluate">
+<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>
+<dd><p>Evaluate items which are instances of L{Reference} or L{Expression}.</p>
+<p>L{Reference} instances are evaluated using L{Reference.resolve},
+and L{Expression} instances are evaluated using
+L{Expression.evaluate}.</p>
+<p>@param item: The item to be evaluated.
+@type item: any
+@return: If the item is an instance of L{Reference} or L{Expression},
+the evaluated value is returned, otherwise the item is returned
+unchanged.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.setPath">
+<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>
+<dd><p>Set the path for this instance.
+@param path: The path - a string which describes how to get
+to this instance from the root of the hierarchy.
+@type path: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.writeToStream">
+<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>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}
+@raise NotImplementedError: If a subclass does not override this</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.writeValue">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Expression">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class implements a value which is obtained by evaluating an expression.</p>
+<dl class="method">
+<dt id="src.pyconf.Expression.evaluate">
+<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>
+<dd><p>Evaluate this instance in the context of a container.</p>
+<p>@param container: The container to evaluate in from.
+@type container: L{Container}
+@return: The evaluated value.
+@rtype: any
+@raise ConfigResolutionError: If evaluation fails.
+@raise ZeroDivideError: If division by zero occurs.
+@raise TypeError: If the operation is invalid, e.g.
+subtracting one string from another.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Mapping">
+<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>
+<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>
+<p>This internal class implements key-value mappings in configurations.</p>
+<dl class="method">
+<dt id="src.pyconf.Mapping.addMapping">
+<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>
+<dd><p>Add a key-value mapping with a comment.</p>
+<p>@param key: The key for the mapping.
+@type key: str
+@param value: The value for the mapping.
+@type value: any
+@param comment: The comment for the key (can be None).
+@type comment: str
+@param setting: If True, ignore clashes. This is set
+to true when called from L{__setattr__}.
+@raise ConfigFormatError: If an existing key is seen
+again and setting is False.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.get">
+<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>
+<dd><p>Allows a dictionary-style get operation.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.iteritems">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.iterkeys">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.keys">
+<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>
+<dd><p>Return the keys in a similar way to a dictionary.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.writeToStream">
+<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>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Reference">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class implements a value which is a reference to another value.</p>
+<dl class="method">
+<dt id="src.pyconf.Reference.addElement">
+<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>
+<dd><p>Add an element to the reference.</p>
+<p>@param type: The type of reference.
+@type type: BACKTICK or DOLLAR
+@param ident: The identifier which continues the reference.
+@type ident: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Reference.findConfig">
+<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>
+<dd><p>Find the closest enclosing configuration to the specified container.</p>
+<p>@param container: The container to start from.
+@type container: L{Container}
+@return: The closest enclosing configuration, or None.
+@rtype: L{Config}</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Reference.resolve">
+<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>
+<dd><p>Resolve this instance in the context of a container.</p>
+<p>@param container: The container to resolve from.
+@type container: L{Container}
+@return: The resolved value.
+@rtype: any
+@raise ConfigResolutionError: If resolution fails.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Sequence">
+<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>
+<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>
+<p>This internal class implements a value which is a sequence of other values.</p>
+<dl class="class">
+<dt id="src.pyconf.Sequence.SeqIter">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>This internal class implements an iterator for a L{Sequence} instance.</p>
+<dl class="method">
+<dt id="src.pyconf.Sequence.SeqIter.next">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Sequence.append">
+<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>
+<dd><p>Add an item to the sequence.</p>
+<p>@param item: The item to add.
+@type item: any
+@param comment: A comment for the item.
+@type comment: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Sequence.writeToStream">
+<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>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.deepCopyMapping">
+<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>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.defaultMergeResolve">
+<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>
+<dd><p>A default resolver for merge conflicts.
+Returns a string indicating what action to take to resolve the conflict.</p>
+<p>@param map1: The map being merged into.
+@type map1: L{Mapping}.
+@param map2: The map being used as the merge operand.
+@type map2: L{Mapping}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str</p>
+<dl class="docutils">
+<dt>@return: One of "merge", "append", "mismatch" or "overwrite"</dt>
+<dd>indicating what action should be taken. This should
+be appropriate to the objects being merged - e.g.
+there is no point returning "merge" if the two objects
+are instances of L{Sequence}.</dd>
+</dl>
+<p>@rtype: str</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.defaultStreamOpener">
+<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>
+<dd><p>This function returns a read-only stream, given its name. The name passed
+in should correspond to an existing stream, otherwise an exception will be
+raised.</p>
+<p>This is the default value of L{streamOpener}; assign your own callable to
+streamOpener to return streams based on names. For example, you could use
+urllib2.urlopen().</p>
+<p>@param name: The name of a stream, most commonly a file name.
+@type name: str
+@return: A stream with the specified name.
+@rtype: A read-only stream (file-like object)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.isWord">
+<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>
+<dd><p>See if a passed-in value is an identifier. If the value passed in is not a
+string, False is returned. An identifier consists of alphanumerics or
+underscore characters.</p>
+<p>Examples:</p>
+<div class="highlight-python"><pre>isWord('a word') ->False
+isWord('award') -> True
+isWord(9) -> False
+isWord('a_b_c_') ->True</pre>
+</div>
+<p>@note: isWord('9abc') will return True - not exactly correct, but adequate
+for the way it's used here.</p>
+<p>@param s: The name to be tested
+@type s: any
+@return: True if a word, else False
+@rtype: bool</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.makePath">
+<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>
+<dd><p>Make a path from a prefix and suffix.</p>
+<p>Examples:
+makePath('', 'suffix') -> 'suffix'
+makePath('prefix', 'suffix') -> 'prefix.suffix'
+makePath('prefix', '[1]') -> 'prefix[1]'</p>
+<p>@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
+@type prefix: str
+@param suffix: The suffix to use. It is either an identifier or an index in brackets.
+@type suffix: str
+@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
+@rtype: str</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.overwriteMergeResolve">
+<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>
+<dd><p>An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},
+but where a "mismatch" is detected, returns "overwrite" instead.</p>
+<p>@param map1: The map being merged into.
+@type map1: L{Mapping}.
+@param map2: The map being used as the merge operand.
+@type map2: L{Mapping}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.system">
+<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>
+<p>In this file : all functions that do a system call,
+like open a browser or an editor, or call a git command</p>
+<dl class="function">
+<dt id="src.system.archive_extract">
+<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>
+<dd><p>Extracts sources from an archive.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>where</em>) -- The path to the archive.</li>
+<li><strong>str</strong> -- The path where to extract.</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.system.cvs_extract">
+<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>
+<dd><p>Extracts sources from a cvs repository.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>where</em>) -- The cvs protocol.</li>
+<li><strong>str</strong> -- The user to be used.</li>
+<li><strong>str</strong> -- The remote cvs server.</li>
+<li><strong>str</strong> -- <p>.</p>
+</li>
+<li><strong>str</strong> -- The tag.</li>
+<li><strong>str</strong> -- The product.</li>
+<li><strong>str</strong> -- The path where to extract.</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
+<li><strong>boolean</strong> (<em>checkout</em>) -- If true use checkout cvs.</li>
+<li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
+extracting.</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.system.git_extract">
+<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>
+<dd><p>Extracts sources from a git repository.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>where</em>) -- The remote git repository.</li>
+<li><strong>str</strong> -- The tag.</li>
+<li><strong>str</strong> -- The path where to extract.</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
+<li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
+extracting.</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.system.show_in_editor">
+<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>
+<dd><p>open filePath using editor.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>filePath</em>) -- The editor to use.</li>
+<li><strong>str</strong> -- The path to the file to open.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.system.svn_extract">
+<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>
+<dd><p>Extracts sources from a svn repository.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>where</em>) -- The user to be used.</li>
+<li><strong>str</strong> -- The remote git repository.</li>
+<li><strong>str</strong> -- The tag.</li>
+<li><strong>str</strong> -- The path where to extract.</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
+<li><strong>boolean</strong> (<em>checkout</em>) -- If true use checkout svn.</li>
+<li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
+extracting.</li>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.template">
+<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>
+<dl class="class">
+<dt id="src.template.MyTemplate">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">string.Template</span></tt></p>
+<dl class="attribute">
+<dt id="src.template.MyTemplate.delimiter">
+<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>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.template.MyTemplate.pattern">
+<tt class="descname">pattern</tt><em class="property"> = <_sre.SRE_Pattern object at 0x24c9d70></em><a class="headerlink" href="#src.template.MyTemplate.pattern" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.template.substitute">
+<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>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.test_module">
+<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>
+<dl class="class">
+<dt id="src.test_module.Test">
+<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>
+<dd><dl class="method">
+<dt id="src.test_module.Test.generate_launching_commands">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.generate_script">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.get_test_timeout">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.get_tmp_dir">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_dir">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_git">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_svn">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.read_results">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_all_tests">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_grid_tests">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_script">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_session_tests">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_testbase_tests">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_tests">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.search_known_errors">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.write_test_margin">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.test_module.getTmpDirDEFAULT">
+<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>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.xmlManager">
+<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>
+<dl class="class">
+<dt id="src.xmlManager.ReadXmlFile">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Class to manage reading of an xml log file</p>
+<dl class="method">
+<dt id="src.xmlManager.ReadXmlFile.getRootAttrib">
+<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>
+<dd><p>Get the attibutes of the self.xmlroot</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The attributes of the root node</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.ReadXmlFile.get_attrib">
+<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>
+<dd><p>Get the attibutes of the node node_name in self.xmlroot</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<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>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.ReadXmlFile.get_node_text">
+<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>
+<dd><p>Get the text of the first node that has name
+that corresponds to the parameter node</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the text of the first node that has name
+that corresponds to the parameter node</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.xmlManager.XmlLogFile">
+<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>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Class to manage writing in salomeTools xml log file</p>
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.add_simple_node">
+<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>
+<dd><p>Add a node with some attibutes and text to the root node.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>text</em>) -- the name of the node to add</li>
+<li><strong>str</strong> -- the text of the node</li>
+<li><strong>dict</strong> (<em>attrib</em>) -- the dictionary containing the
+attribute of the new node</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.append_node_attrib">
+<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>
+<dd><p>Append a new attributes to the node that has node_name as name</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>node_name</em>) -- The name of the node on which append text</li>
+<li><strong>dixt</strong> (<em>attrib</em>) -- The attrib to append</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.append_node_text">
+<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>
+<dd><p>Append a new text to the node that has node_name as name</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>text</em>) -- The name of the node on which append text</li>
+<li><strong>str</strong> -- The text to append</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.write_tree">
+<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>
+<dd><p>Write the xml tree in the log file path. Add the stylesheet if asked.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.xmlManager.add_simple_node">
+<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>
+<dd><p>Add a node with some attibutes and text to the root node.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>etree.Element</strong> (<em>root_node</em>) -- the Etree element where to add the new node</li>
+<li><strong>str</strong> (<em>text</em>) -- the name of the node to add</li>
+<li><strong>str</strong> -- the text of the node</li>
+<li><strong>dict</strong> (<em>attrib</em>) -- the dictionary containing the
+attribute of the new node</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.xmlManager.append_node_attrib">
+<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>
+<dd><p>Append a new attributes to the node that has node_name as name</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>etree.Element</strong> (<em>root_node</em>) -- the Etree element
+where to append the new attibutes</li>
+<li><strong>dixt</strong> (<em>attrib</em>) -- The attrib to append</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.xmlManager.find_node_by_attrib">
+<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>
+<dd><p>Find the nfirst ode from xmlroot that has name name_node and that has in
+its attributes {key : value}. Return the node</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>etree.Element</strong> (<em>xmlroot</em>) -- the Etree element where to search</li>
+<li><strong>str</strong> (<em>value</em>) -- the name of node to search</li>
+<li><strong>str</strong> -- the key to search</li>
+<li><strong>str</strong> -- the value to search</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the found node</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">xmlroot etree.Element</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.xmlManager.write_report">
+<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>
+<dd><p>Writes a report file from a XML tree.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>stylesheet</em>) -- The path to the file to create</li>
+<li><strong>etree.Element</strong> (<em>xmlroot</em>) -- the Etree element to write to the file</li>
+<li><strong>str</strong> -- The stylesheet to add to the begin of the file</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="src.colorama.html">colorama Package</a><ul>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../../index.html">
+ <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">src Package</a><ul>
+<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">src</span></tt> Package</a></li>
+<li><a class="reference internal" href="#module-src.ElementTree"><tt class="docutils literal"><span class="pre">ElementTree</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.architecture"><tt class="docutils literal"><span class="pre">architecture</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.compilation"><tt class="docutils literal"><span class="pre">compilation</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.debug"><tt class="docutils literal"><span class="pre">debug</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.environment"><tt class="docutils literal"><span class="pre">environment</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.fileEnviron"><tt class="docutils literal"><span class="pre">fileEnviron</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.fork"><tt class="docutils literal"><span class="pre">fork</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.logger"><tt class="docutils literal"><span class="pre">logger</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.options"><tt class="docutils literal"><span class="pre">options</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.printcolors"><tt class="docutils literal"><span class="pre">printcolors</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.product"><tt class="docutils literal"><span class="pre">product</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.pyconf"><tt class="docutils literal"><span class="pre">pyconf</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.system"><tt class="docutils literal"><span class="pre">system</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.template"><tt class="docutils literal"><span class="pre">template</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.test_module"><tt class="docutils literal"><span class="pre">test_module</span></tt> Module</a></li>
+<li><a class="reference internal" href="#module-src.xmlManager"><tt class="docutils literal"><span class="pre">xmlManager</span></tt> Module</a></li>
+<li><a class="reference internal" href="#subpackages">Subpackages</a><ul>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="modules.html">src</a><ul>
+ <li>Previous: <a href="modules.html" title="previous chapter">src</a></li>
+ <li>Next: <a href="src.colorama.html" title="next chapter">colorama Package</a></li>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../../_sources/commands/apidoc/src.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../../_sources/commands/apidoc/src.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command application — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command log" href="log.html" />
+ <link rel="prev" title="Command launcher" href="launcher.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-application">
+<h1>Command application<a class="headerlink" href="#command-application" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>application</strong> command creates a virtual <a class="reference external" href="http://www.salome-platform.org">SALOME</a> application.
+Virtual SALOME applications are used to start SALOME when distribution is needed.</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Create an application:</p>
+<div class="highlight-python"><pre>sat application <application></pre>
+</div>
+<p>Create the virtual application directory in the salomeTool application directory <tt class="docutils literal"><span class="pre">$APPLICATION.workdir</span></tt>.</p>
+</li>
+<li><p class="first">Give a name to the application:</p>
+<div class="highlight-python"><pre>sat application <application> --name <my_application_name></pre>
+</div>
+<p><em>Remark</em>: this option overrides the name given in the virtual_app section of the configuration file <tt class="docutils literal"><span class="pre">$APPLICATION.virtual_app.name</span></tt>.</p>
+</li>
+<li><p class="first">Change the directory where the application is created:</p>
+<div class="highlight-python"><pre>sat application <application> --target <my_application_directory></pre>
+</div>
+</li>
+<li><p class="first">Set a specific <a class="reference external" href="http://www.salome-platform.org">SALOME</a> resources catalog (it will be used for the distribution of components on distant machines):</p>
+<div class="highlight-python"><pre>sat application <application> --catalog <path_to_catalog></pre>
+</div>
+<p>Note that the catalog specified will be copied to the application directory.</p>
+</li>
+<li><p class="first">Generate the catalog for a list of machines:</p>
+<div class="highlight-python"><pre>sat application <application> --gencat machine1,machine2,machine3</pre>
+</div>
+<p>This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.</p>
+</li>
+<li><p class="first">Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):</p>
+<div class="highlight-python"><pre>sat launcher <application> --use_mesa</pre>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>The virtual application can be configured with the virtual_app section of the configutation file.</p>
+<ul class="simple">
+<li><strong>APPLICATION.virtual_app</strong><ul>
+<li><strong>name</strong> : name of the launcher (to replace the default runAppli).</li>
+<li><strong>application_name</strong> : (optional) the name of the virtual application directory, if missing the default value is <tt class="docutils literal"><span class="pre">$name</span> <span class="pre">+</span> <span class="pre">_appli</span></tt>.</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command application</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="launcher.html" title="previous chapter">Command launcher</a></li>
+ <li>Next: <a href="log.html" title="next chapter">Command log</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/application.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/application.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command clean — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command package" href="package.html" />
+ <link rel="prev" title="Command environ" href="environ.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-clean">
+<h1>Command clean<a class="headerlink" href="#command-clean" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>clean</strong> command removes products in the <em>source, build, or install</em> directories of an application. Theses directories are usually named <tt class="docutils literal"><span class="pre">SOURCES,</span> <span class="pre">BUILD,</span> <span class="pre">INSTALL</span></tt>.</p>
+<p>Use the options to define what directories you want to suppress and to set the list of products</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Clean all previously created <em>build</em> and <em>install</em> directories (example application as <em>SALOME_xx</em>):</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># take care, is long time to restore, sometimes</span>
+sat clean SALOME-xx --build --install
+</pre></div>
+</div>
+</li>
+<li><p class="first">Clean previously created <em>build</em> and <em>install</em> directories, only for products with property <em>is_salome_module</em>:</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat clean SALOME-xxx --build --install <span class="se">\</span>
+ --properties is_salome_module:yes
+</pre></div>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="availables-options">
+<h2>Availables options<a class="headerlink" href="#availables-options" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><ul>
+<li><p class="first"><strong>--products</strong> : Products to clean.</p>
+</li>
+<li><p class="first"><strong>--properties</strong> :</p>
+<div class="line-block">
+<div class="line">Filter the products by their properties.</div>
+<div class="line">Syntax: <em>--properties <property>:<value></em></div>
+</div>
+</li>
+<li><p class="first"><strong>--sources</strong> : Clean the product source directories.</p>
+</li>
+<li><p class="first"><strong>--build</strong> : Clean the product build directories.</p>
+</li>
+<li><p class="first"><strong>--install</strong> : Clean the product install directories.</p>
+</li>
+<li><p class="first"><strong>--all</strong> : Clean the product source, build and install directories.</p>
+</li>
+<li><p class="first"><strong>--sources_without_dev</strong> :</p>
+<div class="line-block">
+<div class="line">Do not clean the products in development mode,</div>
+<div class="line">(they could have <a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a> commits pending).</div>
+</div>
+</li>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>No specific configuration.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command clean</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#availables-options">Availables options</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="environ.html" title="previous chapter">Command environ</a></li>
+ <li>Next: <a href="package.html" title="next chapter">Command package</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/clean.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/clean.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command compile — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command launcher" href="launcher.html" />
+ <link rel="prev" title="Command prepare" href="prepare.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-compile">
+<h1>Command compile<a class="headerlink" href="#command-compile" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>compile</strong> command allows compiling the products of a <a class="reference external" href="http://www.salome-platform.org">SALOME</a> application.</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Compile a complete application:</p>
+<div class="highlight-python"><pre>sat compile <application></pre>
+</div>
+</li>
+<li><p class="first">Compile only some products:</p>
+<div class="highlight-python"><pre>sat compile <application> --products <product1>,<product2> ...</pre>
+</div>
+</li>
+<li><p class="first">Use <em>sat -t</em> to duplicate the logs in the terminal (by default the log are stored and displayed with <em>sat log</em> command):</p>
+<div class="highlight-python"><pre>sat -t compile <application> --products <product1></pre>
+</div>
+</li>
+<li><p class="first">Compile a module and its dependencies:</p>
+<div class="highlight-python"><pre>sat compile <application> --products med --with_fathers</pre>
+</div>
+</li>
+<li><p class="first">Compile a module and the modules depending on it (for example plugins):</p>
+<div class="highlight-python"><pre>sat compile <application> --products med --with_children</pre>
+</div>
+</li>
+<li><p class="first">Clean the build and install directories before starting compilation:</p>
+<div class="highlight-python"><pre>sat compile <application> --products GEOM --clean_all</pre>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<div class="last line-block">
+<div class="line">a warning will be shown if option <em>--products</em> is missing</div>
+<div class="line">(as it will clean everything)</div>
+</div>
+</div>
+</li>
+<li><p class="first">Clean only the install directories before starting compilation:</p>
+<div class="highlight-python"><pre>sat compile <application> --clean_install</pre>
+</div>
+</li>
+<li><p class="first">Add options for make:</p>
+<div class="highlight-python"><pre>sat compile <application> --products <product> --make_flags <flags></pre>
+</div>
+</li>
+<li><p class="first">Use the <em>--check</em> option to execute the unit tests after compilation:</p>
+<div class="highlight-python"><pre>sat compile <application> --check</pre>
+</div>
+</li>
+<li><p class="first">Remove the build directory after successful compilation (some build directory like qt are big):</p>
+<div class="highlight-python"><pre>sat compile <application> --products qt --clean_build_after</pre>
+</div>
+</li>
+<li><p class="first">Stop the compilation as soon as the compilation of a module fails:</p>
+<div class="highlight-python"><pre>sat compile <product> --stop_first_fail</pre>
+</div>
+</li>
+<li><p class="first">Do not compile, just show if products are installed or not, and where is the installation:</p>
+<div class="highlight-python"><pre>sat compile <application> --show</pre>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>The way to compile a product is defined in the <em>pyconf file configuration</em>.
+The main options are:</p>
+<blockquote>
+<div><ul class="simple">
+<li><strong>build_source</strong> : the method used to build the product (cmake/autotools/script)</li>
+<li><strong>compil_script</strong> : the compilation script if build_source is equal to "script"</li>
+<li><strong>cmake_options</strong> : additional options for cmake.</li>
+<li><strong>nb_proc</strong> : number of jobs to use with make for this product.</li>
+</ul>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command compile</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="prepare.html" title="previous chapter">Command prepare</a></li>
+ <li>Next: <a href="launcher.html" title="next chapter">Command launcher</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/compile.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/compile.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command config — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command prepare" href="prepare.html" />
+ <link rel="prev" title="Usage of SAlomeTools" href="../usage_of_sat.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-config">
+<h1>Command config<a class="headerlink" href="#command-config" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>config</strong> command manages sat configuration.
+It allows display, manipulation and operation on configuration files</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Edit the user personal configuration file <tt class="docutils literal"><span class="pre">$HOME/.salomeTools/SAT.pyconf</span></tt>. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:</p>
+<div class="highlight-python"><pre>sat config --edit</pre>
+</div>
+</li>
+<li><p class="first">List the available applications (they come from the sat projects defined in <tt class="docutils literal"><span class="pre">data/local.pyconf</span></tt>:</p>
+<div class="highlight-python"><pre>sat config --list</pre>
+</div>
+</li>
+<li><p class="first">Edit the configuration of an application:</p>
+<div class="highlight-python"><pre>sat config <application> --edit</pre>
+</div>
+</li>
+<li><p class="first">Copy an application configuration file into the user personal directory:</p>
+<div class="highlight-python"><pre>sat config <application> --copy [new_name]</pre>
+</div>
+</li>
+<li><div class="first line-block">
+<div class="line">Print the value of a configuration parameter.</div>
+<div class="line">Use the automatic completion to get recursively the parameter names.</div>
+<div class="line">Use <em>--no_label</em> option to get <em>only</em> the value, <em>without</em> label (useful in automatic scripts).</div>
+<div class="line">Examples (with <em>SALOME-xx</em> as <em>SALOME-8.4.0</em> ):</div>
+</div>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># sat config --value <parameter_path></span>
+sat config --value . <span class="c"># all the configuration</span>
+sat config --value LOCAL
+sat config --value LOCAL.workdir
+
+<span class="c"># sat config <application> --value <parameter_path></span>
+sat config SALOME-xx --value APPLICATION.workdir
+sat config SALOME-xx --no_label --value APPLICATION.workdir
+</pre></div>
+</div>
+</li>
+<li><div class="first line-block">
+<div class="line">Print in one-line-by-value mode the value of a configuration parameter,</div>
+<div class="line">with its source <em>expression</em>, if any.</div>
+<div class="line">This is a debug mode, useful for developers.</div>
+<div class="line">Prints the parameter path, the source expression if any, and the final value:</div>
+</div>
+<div class="highlight-python"><pre>sat config SALOME-xx -g USER</pre>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>And so, <em>not only for fun</em>, to get <strong>all expressions</strong> of configuration</p>
+<div class="last highlight-bash"><div class="highlight"><pre>sat config SALOME-xx -g . | grep -e <span class="s2">"-->"</span>
+</pre></div>
+</div>
+</div>
+</li>
+<li><p class="first">Print the patches that are applied:</p>
+<div class="highlight-python"><pre>sat config SALOME-xx --show_patchs</pre>
+</div>
+</li>
+<li><p class="first">Get information on a product configuration:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># sat config <application> --info <product></span>
+sat config SALOME-xx --info KERNEL
+sat config SALOME-xx --info qt
+</pre></div>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>Exploring a current configuration.</p>
+<ul class="simple">
+<li><strong>PATHS</strong>: To get list of directories where to find files.</li>
+<li><strong>USER</strong>: To get user preferences (editor, pdf viewer, web browser, default working dir).</li>
+</ul>
+<p>sat commands:</p>
+<div class="highlight-python"><pre>sat config SALOME-xx -v PATHS
+sat config SALOME-xx -v USERS</pre>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command config</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="../usage_of_sat.html" title="previous chapter">Usage of SAlomeTools</a></li>
+ <li>Next: <a href="prepare.html" title="next chapter">Command prepare</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/config.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/config.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command environ — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command clean" href="clean.html" />
+ <link rel="prev" title="Command log" href="log.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-environ">
+<h1>Command environ<a class="headerlink" href="#command-environ" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>environ</strong> command generates the environment files used
+to run and compile your application (as <a class="reference external" href="http://www.salome-platform.org">SALOME</a> is an example).</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>these files are <strong>not</strong> required,
+salomeTool set the environment himself, when compiling.
+And so does the salome launcher.</p>
+<p class="last">These files are useful when someone wants to check the environment.
+They could be used in debug mode to set the environment for <em>gdb</em>.</p>
+</div>
+<p>The configuration part at the end of this page explains how
+to specify the environment used by sat (at build or run time),
+and saved in some files by <em>sat environ</em> command.</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Create the shell environment files of the application:</p>
+<div class="highlight-python"><pre>sat environ <application></pre>
+</div>
+</li>
+<li><p class="first">Create the environment files of the application for a given shell.
+Options are bash, bat (for windows) and cfg (the configuration format used by <a class="reference external" href="http://www.salome-platform.org">SALOME</a>):</p>
+<div class="highlight-python"><pre>sat environ <application> --shell [bash|cfg|all]</pre>
+</div>
+</li>
+<li><p class="first">Use a different prefix for the files (default is 'env'):</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># This will create file <prefix>_launch.sh, <prefix>_build.sh</span>
+sat environ <application> --prefix <prefix>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Use a different target directory for the files:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># This will create file env_launch.sh, env_build.sh</span>
+<span class="c"># in the directory corresponding to <path></span>
+sat environ <application> --target <path>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Generate the environment files only with the given products:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># This will create the environment files only for the given products</span>
+<span class="c"># and their prerequisites.</span>
+<span class="c"># It is useful when you want to visualise which environment uses</span>
+<span class="c"># sat to compile a given product.</span>
+sat environ <application> --product <product1>,<product2>, ...
+</pre></div>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="configuration">
+<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<p>The specification of the environment can be done through several mechanisms.</p>
+<ol class="arabic simple">
+<li>For salome products (the products with the property <tt class="docutils literal"><span class="pre">is_SALOME_module</span></tt> as <tt class="docutils literal"><span class="pre">yes</span></tt>) the environment is set automatically by sat, in respect with <a class="reference external" href="http://www.salome-platform.org">SALOME</a> requirements.</li>
+<li>For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.</li>
+</ol>
+<p>Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
+In the following example, we prepend <em><install_dir>/lib</em> to <tt class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></tt> (note the <em>left first</em> underscore), append <em><install_dir>/lib</em> to <tt class="docutils literal"><span class="pre">PYTHONPATH</span></tt> (note the <em>right last</em> underscore), and set <tt class="docutils literal"><span class="pre">LAPACK_ROOT_DIR</span></tt> to <em><install_dir></em>:</p>
+<div class="highlight-python"><pre>environ :
+{
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ LAPACK_ROOT_DIR : $install_dir
+}</pre>
+</div>
+<p>It is possible to distinguish the build environment from the launch environment: use a subsection called <em>build</em> or <em>launch</em>. In the example below, <tt class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></tt> and <tt class="docutils literal"><span class="pre">PYTHONPATH</span></tt> are only modified at run time, not at compile time:</p>
+<div class="highlight-python"><pre>environ :
+{
+ build :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ }
+ launch :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ }
+}</pre>
+</div>
+<ol class="arabic simple" start="3">
+<li>The last possibility is to set the environment with a python script. The script should be provided in the <em>products/env_scripts</em> directory of the sat project, and its name is specified in the environment section with the key <tt class="docutils literal"><span class="pre">environ.env_script</span></tt>:</li>
+</ol>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">environ</span> <span class="p">:</span>
+<span class="p">{</span>
+ <span class="n">env_script</span> <span class="p">:</span> <span class="s">'lapack.py'</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Please note that the two modes are complementary and are both taken into account.
+Most of the time, the first mode is sufficient.</p>
+<p>The second mode can be used when the environment has to be set programmatically.
+The developer implements a handle (as a python method)
+which is called by sat to set the environment.
+Here is an example:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
+<span class="c">#-*- coding:utf-8 -*-</span>
+
+<span class="kn">import</span> <span class="nn">os.path</span>
+<span class="kn">import</span> <span class="nn">platform</span>
+
+<span class="k">def</span> <span class="nf">set_env</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">prereq_dir</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"TRUST_ROOT_DIR"</span><span class="p">,</span><span class="n">prereq_dir</span><span class="p">)</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prereq_dir</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">))</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prereq_dir</span><span class="p">,</span> <span class="s">'include'</span><span class="p">))</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s">'LD_LIBRARY_PATH'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prereq_dir</span><span class="p">,</span> <span class="s">'lib'</span><span class="p">))</span>
+ <span class="k">return</span>
+</pre></div>
+</div>
+<p>SalomeTools defines four handles:</p>
+<ul class="simple">
+<li><strong>set_env(env, prereq_dir, version)</strong> : used at build and run time.</li>
+<li><strong>set_env_launch(env, prereq_dir, version)</strong> : used only at run time (if defined!)</li>
+<li><strong>set_env_build(env, prereq_dir, version)</strong> : used only at build time (if defined!)</li>
+<li><strong>set_native_env(env)</strong> : used only for native products, at build and run time.</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command environ</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#configuration">Configuration</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="log.html" title="previous chapter">Command log</a></li>
+ <li>Next: <a href="clean.html" title="next chapter">Command clean</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/environ.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/environ.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command generate — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Add a user custom command" href="../write_command.html" />
+ <link rel="prev" title="Command package" href="package.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-generate">
+<h1>Command generate<a class="headerlink" href="#command-generate" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>generate</strong> command generates and compile SALOME modules from cpp modules using YACSGEN.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This command uses YACSGEN to generate the module. It needs to be specified with <em>--yacsgen</em> option, or defined in the product or by the environment variable <tt class="docutils literal"><span class="pre">$YACSGEN_ROOT_DIR</span></tt>.</p>
+</div>
+</div>
+<div class="section" id="remarks">
+<h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">This command will only apply on the CPP modules of the application, those who have both properties:</p>
+<div class="highlight-python"><pre>cpp : "yes"
+generate : "yes"</pre>
+</div>
+</li>
+<li><p class="first">The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)</p>
+</li>
+</ul>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Generate all the modules of a product:</p>
+<div class="highlight-python"><pre>sat generate <application></pre>
+</div>
+</li>
+<li><p class="first">Generate only specific modules:</p>
+<div class="highlight-python"><pre>sat generate <application> --products <list_of_products></pre>
+</div>
+<p>Remark: modules which don't have the <em>generate</em> property are ignored.</p>
+</li>
+<li><p class="first">Use a specific version of YACSGEN:</p>
+<div class="highlight-python"><pre>sat generate <application> --yacsgen <path_to_yacsgen></pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command generate</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#remarks">Remarks</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="package.html" title="previous chapter">Command package</a></li>
+ <li>Next: <a href="../write_command.html" title="next chapter">Add a user custom command</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/generate.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/generate.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command launcher — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command application" href="application.html" />
+ <link rel="prev" title="Command compile" href="compile.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-launcher">
+<h1>Command launcher<a class="headerlink" href="#command-launcher" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>launcher</strong> command creates a SALOME launcher, a python script file to start <a class="reference external" href="http://www.salome-platform.org">SALOME</a>.</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Create a launcher:</p>
+<div class="highlight-python"><pre>sat launcher <application></pre>
+</div>
+<p>Generate a launcher in the application directory, i.e <tt class="docutils literal"><span class="pre">$APPLICATION.workdir</span></tt>.</p>
+</li>
+<li><p class="first">Create a launcher with a given name (default name is <tt class="docutils literal"><span class="pre">APPLICATION.profile.launcher_name</span></tt>)</p>
+<div class="highlight-python"><pre>sat launcher <application> --name ZeLauncher</pre>
+</div>
+<p>The launcher will be called <em>ZeLauncher</em>.</p>
+</li>
+<li><p class="first">Set a specific resources catalog:</p>
+<div class="highlight-python"><pre>sat launcher <application> --catalog <path of a salome resources catalog></pre>
+</div>
+<p>Note that the catalog specified will be copied to the profile directory.</p>
+</li>
+<li><p class="first">Generate the catalog for a list of machines:</p>
+<div class="highlight-python"><pre>sat launcher <application> --gencat <list of machines></pre>
+</div>
+<p>This will create a catalog by querying each machine (memory, number of processor) with ssh.</p>
+</li>
+<li><p class="first">Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):</p>
+<div class="highlight-python"><pre>sat launcher <application> --use_mesa</pre>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="configuration">
+<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<p>Some useful configuration pathes:</p>
+<ul class="simple">
+<li><strong>APPLICATION.profile</strong><ul>
+<li><strong>product</strong> : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)</li>
+<li><strong>launcher_name</strong> : the name of the launcher.</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command launcher</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#configuration">Configuration</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="compile.html" title="previous chapter">Command compile</a></li>
+ <li>Next: <a href="application.html" title="next chapter">Command application</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/launcher.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/launcher.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command log — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command environ" href="environ.html" />
+ <link rel="prev" title="Command application" href="application.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-log">
+<h1>Command log<a class="headerlink" href="#command-log" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>log</strong> command displays sat log in a web browser or in a terminal.</p>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Show (in a web browser) the log of the commands corresponding to an application:</p>
+<div class="highlight-python"><pre>sat log <application></pre>
+</div>
+</li>
+<li><p class="first">Show the log for commands that do not use any application:</p>
+<div class="highlight-python"><pre>sat log</pre>
+</div>
+</li>
+<li><p class="first">The --terminal (or -t) display the log directly in the terminal, through a <a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a> interactive menu:</p>
+<div class="highlight-python"><pre>sat log <application> --terminal</pre>
+</div>
+</li>
+<li><p class="first">The --last option displays only the last command:</p>
+<div class="highlight-python"><pre>sat log <application> --last</pre>
+</div>
+</li>
+<li><p class="first">To access the last compilation log in terminal mode, use --last_terminal option:</p>
+<div class="highlight-python"><pre>sat log <application> --last_terminal</pre>
+</div>
+</li>
+<li><p class="first">The --clean (int) option erases the n older log files and print the number of remaining log files:</p>
+<div class="highlight-python"><pre>sat log <application> --clean 50</pre>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><strong>USER</strong><ul>
+<li><strong>browser</strong> : The browser used to show the log (by default <em>firefox</em>).</li>
+<li><strong>log_dir</strong> : The directory used to store the log files.</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command log</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="application.html" title="previous chapter">Command application</a></li>
+ <li>Next: <a href="environ.html" title="next chapter">Command environ</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/log.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/log.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command package — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command generate" href="generate.html" />
+ <link rel="prev" title="Command clean" href="clean.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-package">
+<h1>Command package<a class="headerlink" href="#command-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>package</strong> command creates a <a class="reference external" href="http://www.salome-platform.org">SALOME</a> archive (usually a compressed <a class="reference external" href="https://en.wikipedia.org/wiki/Tar_(computing)">Tar</a> file .tgz).
+This tar file is used later to intall SALOME on other remote computer.</p>
+<p>Depending on the selected options, the archive includes sources and binaries
+of SALOME products and prerequisites.</p>
+<p>Usually utility <em>salomeTools</em> is included in the archive.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">By default the package includes the sources of prerequisites and products.
+To select a subset use the <em>--without_property</em> or <em>--with_vcs</em> options.</p>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Create a package for a product (example as <em>SALOME_xx</em>):</p>
+<div class="highlight-python"><pre>sat package SALOME_xx</pre>
+</div>
+<p>This command will create an archive named <tt class="docutils literal"><span class="pre">SALOME_xx.tgz</span></tt>
+in the working directory (<tt class="docutils literal"><span class="pre">USER.workDir</span></tt>).
+If the archive already exists, do nothing.</p>
+</li>
+<li><p class="first">Create a package with a specific name:</p>
+<div class="highlight-python"><pre>sat package SALOME_xx --name YourSpecificName</pre>
+</div>
+</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>By default, the archive is created in the working directory of the user (<tt class="docutils literal"><span class="pre">USER.workDir</span></tt>).</p>
+<p>If the option <em>--name</em> is used with a path (relative or absolute) it will be used.</p>
+<p>If the option <em>--name</em> is not used and binaries (prerequisites and products)
+are included in the package, the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture
+will be appended to the name (example: <tt class="docutils literal"><span class="pre">SALOME_xx-CO7.tgz</span></tt>).</p>
+<p>Examples:</p>
+<div class="last highlight-python"><pre># Creates SALOME_xx.tgz in $USER.workDir
+sat package SALOME_xx
+
+# Creates SALOME_xx_<arch>.tgz in $USER.workDir
+sat package SALOME_xx --binaries
+
+# Creates MySpecificName.tgz in $USER.workDir
+sat package SALOME_xx --name MySpecificName</pre>
+</div>
+</div>
+<ul>
+<li><p class="first">Force the creation of the archive (if it already exists):</p>
+<div class="highlight-python"><pre>sat package SALOME_xx --force</pre>
+</div>
+</li>
+<li><p class="first">Include the binaries in the archive (products and prerequisites):</p>
+<div class="highlight-python"><pre>sat package SALOME_xx --binaries</pre>
+</div>
+<p>This command will create an archive named <tt class="docutils literal"><span class="pre">SALOME_xx</span> <span class="pre">_<arch>.tgz</span></tt>
+where <arch> is the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture of the machine.</p>
+</li>
+<li><p class="first">Do not delete Version Control System (<a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a>) informations from the configurations files of the embedded salomeTools:</p>
+<div class="highlight-python"><pre>sat package SALOME_xx --with_vcs</pre>
+</div>
+<p>The version control systems known by this option are <a class="reference external" href="https://fr.wikipedia.org/wiki/Concurrent_versions_system">CVS</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Apache_Subversion">SVN</a> and <a class="reference external" href="https://git-scm.com">Git</a>.</p>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>No specific configuration.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command package</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="clean.html" title="previous chapter">Command clean</a></li>
+ <li>Next: <a href="generate.html" title="next chapter">Command generate</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/package.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/package.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Command prepare — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="next" title="Command compile" href="compile.html" />
+ <link rel="prev" title="Command config" href="config.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="command-prepare">
+<h1>Command prepare<a class="headerlink" href="#command-prepare" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p>The <strong>prepare</strong> command brings the sources of an application in the <em>sources
+application directory</em>, in order to compile them with the compile command.</p>
+<p>The sources can be prepared from VCS software (<em>cvs, svn, git</em>), an archive or a directory.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">When sat prepares a product, it first removes the
+existing directory, except if the development mode is activated.
+When you are working on a product, you need to declare in
+the application configuration this product in <strong>dev</strong> mode.</p>
+</div>
+</div>
+<div class="section" id="remarks">
+<h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="vcs-bases-git-svn-cvs">
+<h3>VCS bases (git, svn, cvs)<a class="headerlink" href="#vcs-bases-git-svn-cvs" title="Permalink to this headline">¶</a></h3>
+<p>The <em>prepare</em> command does not manage authentication on the cvs server.
+For example, to prepare modules from a cvs server, you first need to login once.</p>
+<p>To avoid typing a password for each product,
+you may use a ssh key with passphrase, or store your password
+(in .cvspass or .gitconfig files).
+If you have security concerns, it is also possible to use
+a bash agent and type your password only once.</p>
+</div>
+<div class="section" id="dev-mode">
+<h3>Dev mode<a class="headerlink" href="#dev-mode" title="Permalink to this headline">¶</a></h3>
+<p>By default <em>prepare</em> uses <em>export</em> mode: it creates an image
+of the sources, corresponding to the tag or branch specified,
+without any link to the VCS base.
+To perform a <em>checkout</em> (svn, cvs) or a <em>git clone</em> (git),
+you need to declare the product in dev mode in your application configuration:
+edit the application configuration file (pyconf) and modify the product declaration:</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat config <application> -e
+<span class="c"># and edit the product section:</span>
+<span class="c"># <product> : {tag : "my_tag", dev : "yes", debug : "yes"}</span>
+</pre></div>
+</div>
+<p>The first time you will execute the <em>sat prepare</em> command,
+your module will be downloaded in <em>checkout</em> mode
+(inside the SOURCES directory of the application.
+Then, you can develop in this repository, and finally push
+them in the base when they are ready.
+If you type during the development process by mistake
+a <em>sat prepare</em> command, the sources in dev mode will
+not be altered/removed (Unless you use -f option)</p>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<ul>
+<li><p class="first">Prepare the sources of a complete application in SOURCES directory (all products):</p>
+<div class="highlight-python"><pre>sat prepare <application></pre>
+</div>
+</li>
+<li><p class="first">Prepare only some modules:</p>
+<div class="highlight-python"><pre>sat prepare <application> --products <product1>,<product2> ...</pre>
+</div>
+</li>
+<li><p class="first">Use --force to force to prepare the products in development mode
+(this will remove the sources and do a new clone/checkout):</p>
+<div class="highlight-python"><pre>sat prepare <application> --force</pre>
+</div>
+</li>
+<li><p class="first">Use --force_patch to force to apply patch to the products
+in development mode (otherwise they are not applied):</p>
+<div class="highlight-python"><pre>sat prepare <application> --force_patch</pre>
+</div>
+</li>
+</ul>
+</div>
+<div class="section" id="some-useful-configuration-pathes">
+<h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
+<p>Command <em>sat prepare</em> uses the <em>pyconf file configuration</em> of each product to know how to get the sources.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>to verify configuration of a product, and get name of this <em>pyconf files configuration</em></p>
+<div class="last highlight-bash"><div class="highlight"><pre>sat config <application> --info <product>
+</pre></div>
+</div>
+</div>
+<ul class="simple">
+<li><strong>get_method</strong>: the method to use to prepare the module, possible values are cvs, git, archive, dir.</li>
+<li><strong>git_info</strong> : (used if get_method = git) information to prepare sources from git.</li>
+<li><strong>svn_info</strong> : (used if get_method = svn) information to prepare sources from cvs.</li>
+<li><strong>cvs_info</strong> : (used if get_method = cvs) information to prepare sources from cvs.</li>
+<li><strong>archive_info</strong> : (used if get_method = archive) the path to the archive.</li>
+<li><strong>dir_info</strong> : (used if get_method = dir) the directory with the sources.</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Command prepare</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#remarks">Remarks</a><ul>
+<li><a class="reference internal" href="#vcs-bases-git-svn-cvs">VCS bases (git, svn, cvs)</a></li>
+<li><a class="reference internal" href="#dev-mode">Dev mode</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="config.html" title="previous chapter">Command config</a></li>
+ <li>Next: <a href="compile.html" title="next chapter">Command compile</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/prepare.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/commands/prepare.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Configuration — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+ <link rel="next" title="Usage of SAlomeTools" href="usage_of_sat.html" />
+ <link rel="prev" title="Installation" href="installation_of_sat.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="configuration">
+<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
+<p><em>salomeTools</em> uses files to store its configuration parameters.</p>
+<p>There are several configuration files which are loaded by salomeTools in a specific order.
+When all the files are loaded a <em>config</em> object is created.
+Then, this object is passed to all command scripts.</p>
+<div class="section" id="syntax">
+<h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p>The configuration files use a python-like structure format
+(see <a class="reference external" href="http://www.red-dove.com/config-doc/">config module</a> for a complete description).</p>
+<ul class="simple">
+<li><strong>{}</strong> define a dictionary,</li>
+<li><strong>[]</strong> define a list,</li>
+<li><strong>@</strong> can be used to include a file,</li>
+<li><strong>$prefix</strong> reference to another parameter (ex: <tt class="docutils literal"><span class="pre">$PRODUCT.name</span></tt>),</li>
+<li><strong>#</strong> comments.</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">in this documentation a reference to a configuration parameter will be noted <tt class="docutils literal"><span class="pre">XXX.YYY</span></tt>.</p>
+</div>
+</div>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="vars-section">
+<span id="id1"></span><h3>VARS section<a class="headerlink" href="#vars-section" title="Permalink to this headline">¶</a></h3>
+<div class="line-block">
+<div class="line">This section is dynamically created by salomeTools at run time.</div>
+<div class="line">It contains information about the environment: date, time, OS, architecture etc.</div>
+</div>
+<div class="highlight-python"><pre># to get the current setting
+sat config --value VARS</pre>
+</div>
+</div>
+<div class="section" id="products-section">
+<h3>PRODUCTS section<a class="headerlink" href="#products-section" title="Permalink to this headline">¶</a></h3>
+<div class="line-block">
+<div class="line">This section is defined in the product file.</div>
+<div class="line">It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)</div>
+</div>
+<div class="highlight-python"><pre># to get the current setting
+sat config SALOME-xx --value PRODUCTS</pre>
+</div>
+</div>
+<div class="section" id="application-section">
+<h3>APPLICATION section<a class="headerlink" href="#application-section" title="Permalink to this headline">¶</a></h3>
+<div class="line-block">
+<div class="line">This section is optional, it is also defined in the product file.</div>
+<div class="line">It gives additional parameters to create an application based on SALOME, as versions of products to use.</div>
+</div>
+<div class="highlight-python"><pre># to get the current setting
+sat config SALOME-xx --value APPLICATION</pre>
+</div>
+</div>
+<div class="section" id="user-section">
+<span id="id2"></span><h3>USER section<a class="headerlink" href="#user-section" title="Permalink to this headline">¶</a></h3>
+<p>This section is defined by the user configuration file,
+<tt class="docutils literal"><span class="pre">~/.salomeTools/salomeTools.pyconf</span></tt>.</p>
+<p>The <tt class="docutils literal"><span class="pre">USER</span></tt> section defines some parameters (not exhaustive):</p>
+<ul>
+<li><p class="first"><strong>workDir</strong> :</p>
+<blockquote>
+<div><div class="line-block">
+<div class="line">The working directory.</div>
+<div class="line">Each product will be usually installed here (in sub-directories).</div>
+</div>
+</div></blockquote>
+</li>
+<li><p class="first"><strong>browser</strong> : The web browser to use (<em>firefox</em>).</p>
+</li>
+<li><p class="first"><strong>editor</strong> : The editor to use (<em>vi, pluma</em>).</p>
+</li>
+<li><p class="first">and other user preferences.</p>
+</li>
+</ul>
+<div class="highlight-python"><pre># to get the current setting
+sat config SALOME-xx --value USER</pre>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Configuration</a><ul>
+<li><a class="reference internal" href="#syntax">Syntax</a></li>
+<li><a class="reference internal" href="#description">Description</a><ul>
+<li><a class="reference internal" href="#vars-section">VARS section</a></li>
+<li><a class="reference internal" href="#products-section">PRODUCTS section</a></li>
+<li><a class="reference internal" href="#application-section">APPLICATION section</a></li>
+<li><a class="reference internal" href="#user-section">USER section</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="installation_of_sat.html" title="previous chapter">Installation</a></li>
+ <li>Next: <a href="usage_of_sat.html" title="next chapter">Usage of SAlomeTools</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/configuration.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="_sources/configuration.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Index — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#E"><strong>E</strong></a>
+ | <a href="#F"><strong>F</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#H"><strong>H</strong></a>
+ | <a href="#I"><strong>I</strong></a>
+ | <a href="#K"><strong>K</strong></a>
+ | <a href="#L"><strong>L</strong></a>
+ | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
+ | <a href="#O"><strong>O</strong></a>
+ | <a href="#P"><strong>P</strong></a>
+ | <a href="#Q"><strong>Q</strong></a>
+ | <a href="#R"><strong>R</strong></a>
+ | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
+ | <a href="#U"><strong>U</strong></a>
+ | <a href="#W"><strong>W</strong></a>
+ | <a href="#X"><strong>X</strong></a>
+ | <a href="#Y"><strong>Y</strong></a>
+
+</div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.activate_mesa_property">activate_mesa_property() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">add() (src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_comment">add_comment() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.add_comment">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_comment">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_comment">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_comment">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_echo">add_echo() (src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_echo">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_echo">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_echo">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_line">add_line() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_line">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_line">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_line">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.add_link">add_link() (src.logger.Logger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.add_option">add_option() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.add_simple_node">add_simple_node() (in module src.xmlManager)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.add_simple_node">(src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_warning">add_warning() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_warning">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_warning">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_warning">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_warning">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.addElement">addElement() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.addMapping">addMapping() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.addNamespace">addNamespace() (src.pyconf.Config method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE">ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack">AnsiBack (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCodes">AnsiCodes (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor">AnsiCursor (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore">AnsiFore (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle">AnsiStyle (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32">AnsiToWin32 (class in src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.append">append() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.append">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.append">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.append">(src.pyconf.Sequence method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.append_node_attrib">append_node_attrib() (in module src.xmlManager)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_attrib">(src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_text">append_node_text() (src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.append_value">append_value() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.append_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.system.archive_extract">archive_extract() (in module src.system)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.BACK">BACK() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.back">back() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.base">base() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">BashFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.batch">batch() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.batch_salome">batch_salome() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron">BatFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLACK">BLACK (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLACK">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLACK">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLUE">BLUE (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLUE">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLUE">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.BRIGHT">BRIGHT (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT">(src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND">BRIGHT_BACKGROUND (src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.build_configure">build_configure() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder">Builder (class in src.compilation)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="C">C</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.call_win32">call_win32() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.change_to_launcher">change_to_launcher() (src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.check">check() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.check_config_exists">check_config_exists() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.check_config_has_application">check_config_has_application() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.check_config_has_profile">check_config_has_profile() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.check_installation">check_installation() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.check_source">check_source() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.chmod">chmod() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.cleancolor">cleancolor() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_line">clear_line() (in module src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_screen">clear_screen() (in module src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.OutStream.close">close() (src.debug.OutStream method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.close">(src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.close">(src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.close">(src.pyconf.ConfigInputStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.close">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.cmake">cmake() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.code_to_chars">code_to_chars() (in module src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">colorama_text() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.command_value">command_value() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.command_value">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.command_value">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.command_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.command_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.command_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.command_value">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.Comment">Comment() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.complete_environment">complete_environment() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config">Config (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.Namespace">Config.Namespace (class in src.pyconf)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.config_has_application">config_has_application() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigError">ConfigError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigFormatError">ConfigFormatError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream">ConfigInputStream (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigList">ConfigList (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger">ConfigMerger (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream">ConfigOutputStream (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader">ConfigReader (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigResolutionError">ConfigResolutionError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.configure">configure() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container">Container (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron">ContextFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_ansi">convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_osc">convert_osc() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.copy">copy() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.copydir">copydir() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.copyfile">copyfile() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.copylink">copylink() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.cursor_adjust">cursor_adjust() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.cvs_extract">cvs_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.CYAN">CYAN (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.CYAN">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.CYAN">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.data">data() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.date_to_datetime">date_to_datetime() (in module src.logger)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.deepcopy_list">deepcopy_list() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.deepCopyMapping">deepCopyMapping() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.defaultMergeResolve">defaultMergeResolve() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.defaultStreamOpener">defaultStreamOpener() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.deinit">deinit() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate.delimiter">delimiter (src.template.MyTemplate attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.DIM">DIM (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.dir">dir() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_batch_script_build">do_batch_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_default_build">do_default_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_python_script_build">do_python_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_script_build">do_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.doctype">doctype() (src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.DOWN">DOWN() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.dump">dump() (in module src.ElementTree)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.dump">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.Element">Element() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree">ElementTree (class in src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.end">end() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.end_write">end_write() (src.logger.Logger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.ensure_path_exists">ensure_path_exists() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ">Environ (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_line">erase_line() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_screen">erase_screen() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.error">error() (src.logger.Logger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.evaluate">evaluate() (src.pyconf.Container method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Expression.evaluate">(src.pyconf.Expression method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.exists">exists() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Expression">Expression (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.extract_params">extract_params() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.feed">feed() (src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron">FileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter">FileEnvWriter (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.find">find() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.find_file_in_lpath">find_file_in_lpath() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.find_node_by_attrib">find_node_by_attrib() (in module src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findall">findall() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.findConfig">findConfig() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findtext">findtext() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.finish">finish() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.finish">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.finish">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.finish">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.finish">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.finish">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.flush">flush() (src.logger.Logger method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.flush">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.fore">fore() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.FORWARD">FORWARD() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.fromstring">fromstring() (in module src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.generate_launching_commands">generate_launching_commands() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.generate_script">generate_script() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.get">get() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.get">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.get">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.get">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.get">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.get">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.get">(src.pyconf.Mapping method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_attrib">get_attrib() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_attrs">get_attrs() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_base_install_dir">get_base_install_dir() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_base_path">get_base_path() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_cfg_param">get_cfg_param() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_distrib_version">get_distrib_version() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_distribution">get_distribution() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.get_file_environ">get_file_environ() (in module src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_install_dir">get_install_dir() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_launcher_name">get_launcher_name() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_log_path">get_log_path() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get_names">get_names() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_nb_proc">get_nb_proc() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_node_text">get_node_text() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_position">get_position() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_components">get_product_components() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_config">get_product_config() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_dependencies">get_product_dependencies() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_section">get_product_section() (in module src.product)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_products_infos">get_products_infos() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_property_in_product_cfg">get_property_in_product_cfg() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_python_version">get_python_version() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_salome_version">get_salome_version() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.get_test_timeout">get_test_timeout() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.get_tmp_dir">get_tmp_dir() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.get_tmp_filename">get_tmp_filename() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_user">get_user() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.get_win32_calls">get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.getByPath">getByPath() (src.pyconf.Config method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigList.getByPath">(src.pyconf.ConfigList method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getChar">getChar() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getiterator">getiterator() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getLocalEnv">getLocalEnv() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getroot">getroot() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.getRootAttrib">getRootAttrib() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getStrConfigDbg">getStrConfigDbg() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getStrConfigStd">getStrConfigStd() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.getTmpDirDEFAULT">getTmpDirDEFAULT() (in module src.test_module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getToken">getToken() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.git_extract">git_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.GREEN">GREEN (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.GREEN">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREEN">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREY">GREY (src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.hack_libtool">hack_libtool() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.handleMismatch">handleMismatch() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.handleRemoveReadonly">handleRemoveReadonly() (in module src.__init__)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.debug.indent">indent() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.init">init() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.install">install() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.InStream">InStream (class in src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_a_tty">is_a_tty() (in module src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.is_defined">is_defined() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.is_defined">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.is_defined">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.is_defined">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.is_defined">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_stream_closed">is_stream_closed() (in module src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.is_windows">is_windows() (in module src.architecture)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.isdir">isdir() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iselement">iselement() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.isfile">isfile() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.islink">islink() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.isWord">isWord() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.iteritems">iteritems() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.iterkeys">iterkeys() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iterparse">iterparse (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="K">K</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.keys">keys() (src.pyconf.Mapping method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fork.launch_command">launch_command() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron">LauncherFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLACK_EX">LIGHTBLACK_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLACK_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLUE_EX">LIGHTBLUE_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLUE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTCYAN_EX">LIGHTCYAN_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTCYAN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTGREEN_EX">LIGHTGREEN_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTGREEN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX">LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTRED_EX">LIGHTRED_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTRED_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTWHITE_EX">LIGHTWHITE_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTWHITE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX">LIGHTYELLOW_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.list">list() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.list_log_file">list_log_file() (in module src.logger)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.load">load() (src.pyconf.Config method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.load">(src.pyconf.ConfigReader method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.load_cfg_environment">load_cfg_environment() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.load_environment">load_environment() (in module src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.location">location() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.log">log() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.log_command">log_command() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger">Logger (class in src.logger)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.MAGENTA">MAGENTA (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.MAGENTA">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.MAGENTA">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.make">make() (src.__init__.Path method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.make">(src.compilation.Builder method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.makePath">makePath() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping">Mapping (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.match">match() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.merge">merge() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.merge_dicts">merge_dicts() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeMapping">mergeMapping() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeSequence">mergeSequence() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate">MyTemplate (class in src.template)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iterparse.next">next() (src.ElementTree.iterparse method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter.next">(src.pyconf.Sequence.SeqIter method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.NORMAL">NORMAL (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.NORMAL">(src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.only_numbers">only_numbers() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options">Options (class in src.options)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.OptResult">OptResult (class in src.options)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.debug.OutStream">OutStream (class in src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.overwriteKeys">overwriteKeys() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.overwriteMergeResolve">overwriteMergeResolve() (in module src.pyconf)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.parse">parse() (in module src.ElementTree)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.parse">(src.ElementTree.ElementTree method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.parse_args">parse_args() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.parse_date">parse_date() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseFactor">parseFactor() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseKeyValuePair">parseKeyValuePair() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMapping">parseMapping() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMappingBody">parseMappingBody() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseReference">parseReference() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseScalar">parseScalar() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSequence">parseSequence() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSuffix">parseSuffix() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseTerm">parseTerm() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseValue">parseValue() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path">Path (class in src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate.pattern">pattern (src.template.MyTemplate attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.PI">PI() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.pop_debug">pop_debug() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.POS">POS() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.prepare">prepare() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase">prepare_testbase() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_dir">prepare_testbase_from_dir() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_git">prepare_testbase_from_git() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_svn">prepare_testbase_from_svn() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.prepend">prepend() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.prepend">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.prepend">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.prepend_value">prepend_value() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.prepend_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.print_color_map">print_color_map() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.print_color_range">print_color_range() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.print_help">print_help() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.print_info">print_info() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.print_value">print_value() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printc">printc() (in module src.printcolors)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcError">printcError() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcHeader">printcHeader() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcHighlight">printcHighlight() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcInfo">printcInfo() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcLabel">printcLabel() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcSuccess">printcSuccess() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.printcolors.printcWarning">printcWarning() (in module src.printcolors)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ProcessingInstruction">ProcessingInstruction() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_compiles">product_compiles() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_env_script">product_has_env_script() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_logo">product_has_logo() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_patches">product_has_patches() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_salome_gui">product_has_salome_gui() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_script">product_has_script() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_autotools">product_is_autotools() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_cmake">product_is_cmake() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_cpp">product_is_cpp() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_debug">product_is_debug() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_dev">product_is_dev() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_fixed">product_is_fixed() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_generated">product_is_generated() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_mpi">product_is_mpi() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_native">product_is_native() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_salome">product_is_salome() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_sample">product_is_sample() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_smesh_plugin">product_is_smesh_plugin() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_vcs">product_is_vcs() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.push_debug">push_debug() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.put_initial_xml_fields">put_initial_xml_fields() (src.logger.Logger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.put_txt_log_in_appli_log_dir">put_txt_log_in_appli_log_dir() (src.compilation.Builder method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="Q">Q</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.QName">QName (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.read">read() (src.pyconf.ConfigInputStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.read_config_from_a_file">read_config_from_a_file() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.read_results">read_results() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.readline">readline() (src.pyconf.ConfigInputStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.readlink">readlink() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile">ReadXmlFile (class in src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RED">RED (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RED">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.RED">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference">Reference (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reinit">reinit() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.remove_item_from_list">remove_item_from_list() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.removeNamespace">removeNamespace() (src.pyconf.Config method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.replace_in_file">replace_in_file() (in module src.__init__)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RESET">RESET (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RESET">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.RESET_ALL">RESET_ALL (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reset_all">reset_all() (in module src.colorama.initialise)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.reset_all">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.reset_all">(src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.resolve">resolve() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.rm">rm() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_all_tests">run_all_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_env_script">run_env_script() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.run_env_script">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_grid_tests">run_grid_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_script">run_script() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_session_tests">run_session_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_simple_env_script">run_simple_env_script() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_testbase_tests">run_testbase_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_tests">run_tests() (src.test_module.Test method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron">SalomeEnviron (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.SatException">SatException</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.saveConfigDbg">saveConfigDbg() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.saveConfigStd">saveConfigStd() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron">ScreenEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.search_known_errors">search_known_errors() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence">Sequence (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter">Sequence.SeqIter (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.set">set() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.set">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.set">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.set">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.set">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.set">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.set">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_a_product">set_a_product() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_application_env">set_application_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_attrs">set_attrs() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_console">set_console() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_cpp_env">set_cpp_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_cursor_position">set_cursor_position() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_full_environ">set_full_environ() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_products">set_products() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_python_libdirs">set_python_libdirs() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_generic_product_env">set_salome_generic_product_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_minimal_product_env">set_salome_minimal_product_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.set_title">set_title() (in module src.colorama.ansi)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_title">(src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.win32.SetConsoleTextAttribute">SetConsoleTextAttribute() (in module src.colorama.win32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.setPath">setPath() (src.pyconf.Container method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.setStream">setStream() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Shell">Shell (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.should_wrap">should_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.show_command_log">show_command_log() (in module src.logger)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.show_in_editor">show_in_editor() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.show_progress">show_progress() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.smartcopy">smartcopy() (src.__init__.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.special_path_separator">special_path_separator() (in module src.fileEnviron)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#module-src.__init__">src.__init__ (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.architecture">src.architecture (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama">src.colorama (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansi">src.colorama.ansi (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.initialise">src.colorama.initialise (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.win32">src.colorama.win32 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.winterm">src.colorama.winterm (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.compilation">src.compilation (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.debug">src.debug (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.ElementTree">src.ElementTree (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.environment">src.environment (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.fileEnviron">src.fileEnviron (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.fork">src.fork (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.logger">src.logger (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.options">src.options (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.printcolors">src.printcolors (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.product">src.product (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.pyconf">src.pyconf (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.system">src.system (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.template">src.template (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.test_module">src.test_module (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.xmlManager">src.xmlManager (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.start">start() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper">StreamWrapper (class in src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.style">style() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.SubElement">SubElement() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.substitute">substitute() (in module src.template)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.svn_extract">svn_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.__init__.Path.symlink">symlink() (src.__init__.Path method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test">Test (class in src.test_module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.timedelta_total_seconds">timedelta_total_seconds() (in module src.logger)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.tofix">tofix() (in module src.debug)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.tostring">tostring() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder">TreeBuilder (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="U">U</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.UP">UP() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.logger.update_hat_xml">update_hat_xml() (in module src.logger)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.WHITE">WHITE (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.WHITE">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.win32.winapi_test">winapi_test() (in module src.colorama.win32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor">WinColor (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle">WinStyle (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm">WinTerm (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.wmake">wmake() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.wrap_stream">wrap_stream() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.write">write() (in module src.debug)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.write">(src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper.write">(src.colorama.ansitowin32.StreamWrapper method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.write">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.logger.Logger.write">(src.logger.Logger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.write">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_and_convert">write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fork.write_back">write_back() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_cfgForPy_file">write_cfgForPy_file() (src.environment.FileEnvWriter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_env_file">write_env_file() (src.environment.FileEnvWriter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_plain_text">write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.write_report">write_report() (in module src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.write_test_margin">write_test_margin() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.write_tree">write_tree() (src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.writeToStream">writeToStream() (src.pyconf.Container method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.writeToStream">(src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.writeToStream">(src.pyconf.Sequence method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.writeValue">writeValue() (src.pyconf.Container method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="X">X</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XML">XML() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile">XmlLogFile (class in src.xmlManager)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder">XMLTreeBuilder (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="Y">Y</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.YELLOW">YELLOW (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.YELLOW">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.YELLOW">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+
+ <div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Salome Tools — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="#" />
+ <link rel="next" title="Installation" href="installation_of_sat.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="salome-tools">
+<h1>Salome Tools<a class="headerlink" href="#salome-tools" title="Permalink to this headline">¶</a></h1>
+<a class="reference internal image-reference" href="_images/sat_about.png"><img alt="_images/sat_about.png" class="align-center" src="_images/sat_about.png" style="width: 600.0px; height: 300.0px;" /></a>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">This documentation is under construction.</p>
+</div>
+<p>The <strong>Sa</strong>lome<strong>T</strong>ools (sat) is a suite of commands
+that can be used to perform operations on <a class="reference external" href="http://www.salome-platform.org">SALOME</a>.</p>
+<p>For example, sat allows you to compile SALOME's codes
+(prerequisites, products)
+create application, run tests, create package, etc.</p>
+<p>This utility code is a set of <a class="reference external" href="https://docs.python.org/2.7">Python</a> scripts files.</p>
+<div class="section" id="quick-start">
+<h2>Quick start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation_of_sat.html">Installation of salomeTools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage_of_sat.html">Usage of salomeTools</a></li>
+</ul>
+</div>
+</div>
+<div class="section" id="list-of-commands">
+<h2>List of Commands<a class="headerlink" href="#list-of-commands" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="commands/config.html">config</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/prepare.html">prepare</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/compile.html">compile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/launcher.html">launcher</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/application.html">application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/log.html">log</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/environ.html">environ</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/clean.html">clean</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/package.html">package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/generate.html">generate</a></li>
+</ul>
+</div>
+</div>
+<div class="section" id="developer-documentation">
+<h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="write_command.html">Add a command</a></li>
+</ul>
+</div>
+</div>
+<div class="section" id="code-documentation">
+<h2>Code documentation<a class="headerlink" href="#code-documentation" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="commands/apidoc/modules.html">SAT modules</a></li>
+</ul>
+</div>
+</div>
+<div class="section" id="release-notes">
+<h2>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="release_notes/release_notes_5.0.0.html">Release Notes 5.0.0</a></li>
+</ul>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="#">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="#">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Salome Tools</a><ul>
+<li><a class="reference internal" href="#quick-start">Quick start</a><ul>
+</ul>
+</li>
+<li><a class="reference internal" href="#list-of-commands">List of Commands</a><ul>
+</ul>
+</li>
+<li><a class="reference internal" href="#developer-documentation">Developer documentation</a><ul>
+</ul>
+</li>
+<li><a class="reference internal" href="#code-documentation">Code documentation</a><ul>
+</ul>
+</li>
+<li><a class="reference internal" href="#release-notes">Release Notes</a><ul>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="#">Documentation overview</a><ul>
+ <li>Next: <a href="installation_of_sat.html" title="next chapter">Installation</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/index.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="_sources/index.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Installation — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+ <link rel="next" title="Configuration" href="configuration.html" />
+ <link rel="prev" title="Salome Tools" href="index.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="installation">
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<p>Usually user could find (and use) command <strong>sat</strong> directly after a 'detar' installation of SALOME.</p>
+<div class="highlight-bash"><div class="highlight"><pre>tar -xf .../SALOME_xx.tgz
+<span class="nb">cd </span>SALOME_xx
+ls -l sat <span class="c"># sat -> salomeTools/sat</span>
+</pre></div>
+</div>
+<p>Python package (scripts of salomeTools) actually remains in directory <em>salomeTools</em>.</p>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="index.html" title="previous chapter">Salome Tools</a></li>
+ <li>Next: <a href="configuration.html" title="next chapter">Configuration</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/installation_of_sat.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="_sources/installation_of_sat.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Python Module Index — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+
+ <h1>Python Module Index</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-s"><strong>s</strong></a>
+ </div>
+
+ <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-s"><td></td><td>
+ <strong>s</strong></td><td></td></tr>
+ <tr>
+ <td><img src="_static/minus.png" class="toggler"
+ id="toggle-1" style="display: none" alt="-" /></td>
+ <td>
+ <tt class="xref">src</tt></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.__init__"><tt class="xref">src.__init__</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.architecture"><tt class="xref">src.architecture</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama"><tt class="xref">src.colorama</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama.ansi"><tt class="xref">src.colorama.ansi</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama.ansitowin32"><tt class="xref">src.colorama.ansitowin32</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama.initialise"><tt class="xref">src.colorama.initialise</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama.win32"><tt class="xref">src.colorama.win32</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.colorama.html#module-src.colorama.winterm"><tt class="xref">src.colorama.winterm</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.compilation"><tt class="xref">src.compilation</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.debug"><tt class="xref">src.debug</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.ElementTree"><tt class="xref">src.ElementTree</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.environment"><tt class="xref">src.environment</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.fileEnviron"><tt class="xref">src.fileEnviron</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.fork"><tt class="xref">src.fork</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.logger"><tt class="xref">src.logger</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.options"><tt class="xref">src.options</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.printcolors"><tt class="xref">src.printcolors</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.product"><tt class="xref">src.product</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.pyconf"><tt class="xref">src.pyconf</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.system"><tt class="xref">src.system</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.template"><tt class="xref">src.template</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.test_module"><tt class="xref">src.test_module</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="commands/apidoc/src.html#module-src.xmlManager"><tt class="xref">src.xmlManager</tt></a></td><td>
+ <em></em></td></tr>
+ </table>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Release notes — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="prev" title="colorama Package" href="../commands/apidoc/src.colorama.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="release-notes">
+<h1>Release notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
+<p>In construction.</p>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="../commands/apidoc/src.colorama.html" title="previous chapter">colorama Package</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/release_notes/release_notes_5.0.0.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="../_sources/release_notes/release_notes_5.0.0.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Search — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="_static/searchtools.js"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+ <script type="text/javascript">
+ jQuery(function() { Search.loadIndex("searchindex.js"); });
+ </script>
+
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1 id="search-documentation">Search</h1>
+ <div id="fallback" class="admonition warning">
+ <script type="text/javascript">$('#fallback').hide();</script>
+ <p>
+ Please activate JavaScript to enable the search
+ functionality.
+ </p>
+ </div>
+ <p>
+ From here you can search these documents. Enter your search
+ words into the box below and click "search". Note that the search
+ function will automatically search for all of the words. Pages
+ containing fewer words won't appear in the result list.
+ </p>
+ <form action="" method="get">
+ <input type="text" name="q" value="" />
+ <input type="submit" value="search" />
+ <span id="search-progress" style="padding-left: 10px"></span>
+ </form>
+
+ <div id="search-results">
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+Search.setIndex({objects:{"src.fork":{launch_command:[10,1,1,""],show_progress:[10,1,1,""],write_back:[10,1,1,""],batch:[10,1,1,""],batch_salome:[10,1,1,""]},"src.pyconf.ConfigInputStream":{read:[10,2,1,""],close:[10,2,1,""],readline:[10,2,1,""]},"src.colorama":{win32:[3,0,1,""],initialise:[3,0,1,""],winterm:[3,0,1,""],ansitowin32:[3,0,1,""],ansi:[3,0,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],prepend:[10,2,1,""],write:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],run_env_script:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.colorama.ansi.AnsiStyle":{RESET_ALL:[3,4,1,""],DIM:[3,4,1,""],BRIGHT:[3,4,1,""],NORMAL:[3,4,1,""]},"src.pyconf.ConfigReader":{load:[10,2,1,""],getChar:[10,2,1,""],location:[10,2,1,""],setStream:[10,2,1,""],parseReference:[10,2,1,""],parseFactor:[10,2,1,""],parseKeyValuePair:[10,2,1,""],parseMapping:[10,2,1,""],parseTerm:[10,2,1,""],parseSuffix:[10,2,1,""],parseValue:[10,2,1,""],parseMappingBody:[10,2,1,""],getToken:[10,2,1,""],parseScalar:[10,2,1,""],match:[10,2,1,""],parseSequence:[10,2,1,""]},"src.fileEnviron.ContextFileEnviron":{append_value:[10,2,1,""],finish:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],prepend_value:[10,2,1,""],add_echo:[10,2,1,""]},"src.pyconf.Sequence":{SeqIter:[10,3,1,""],writeToStream:[10,2,1,""],append:[10,2,1,""]},"src.pyconf.Mapping":{get:[10,2,1,""],keys:[10,2,1,""],writeToStream:[10,2,1,""],addMapping:[10,2,1,""],iteritems:[10,2,1,""],iterkeys:[10,2,1,""]},"src.colorama.winterm":{WinStyle:[3,3,1,""],WinTerm:[3,3,1,""],WinColor:[3,3,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[10,2,1,""],set:[10,2,1,""],finish:[10,2,1,""],command_value:[10,2,1,""],get:[10,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add_comment:[10,2,1,""],append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],finish:[10,2,1,""],change_to_launcher:[10,2,1,""],add:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],add_line:[10,2,1,""],prepend:[10,2,1,""],is_defined:[10,2,1,""],prepend_value:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.options":{OptResult:[10,3,1,""],Options:[10,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT_BACKGROUND:[3,4,1,""],BRIGHT:[3,4,1,""],NORMAL:[3,4,1,""]},"src.ElementTree.ElementTree":{write:[10,2,1,""],getroot:[10,2,1,""],getiterator:[10,2,1,""],findtext:[10,2,1,""],findall:[10,2,1,""],parse:[10,2,1,""],find:[10,2,1,""]},"src.fileEnviron.BashFileEnviron":{set:[10,2,1,""],command_value:[10,2,1,""],finish:[10,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[10,2,1,""],write_env_file:[10,2,1,""]},"src.logger.Logger":{end_write:[10,2,1,""],flush:[10,2,1,""],write:[10,2,1,""],add_link:[10,2,1,""],error:[10,2,1,""],put_initial_xml_fields:[10,2,1,""]},"src.fileEnviron":{get_file_environ:[10,1,1,""],ContextFileEnviron:[10,3,1,""],LauncherFileEnviron:[10,3,1,""],BatFileEnviron:[10,3,1,""],ScreenEnviron:[10,3,1,""],BashFileEnviron:[10,3,1,""],special_path_separator:[10,1,1,""],FileEnviron:[10,3,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[3,2,1,""]},"src.debug.OutStream":{close:[10,2,1,""]},"src.compilation":{Builder:[10,3,1,""]},"src.colorama.winterm.WinTerm":{style:[3,2,1,""],erase_screen:[3,2,1,""],get_position:[3,2,1,""],get_attrs:[3,2,1,""],back:[3,2,1,""],fore:[3,2,1,""],set_console:[3,2,1,""],set_attrs:[3,2,1,""],set_title:[3,2,1,""],cursor_adjust:[3,2,1,""],reset_all:[3,2,1,""],set_cursor_position:[3,2,1,""],erase_line:[3,2,1,""]},"src.colorama.win32":{winapi_test:[3,1,1,""],SetConsoleTextAttribute:[3,1,1,""]},"src.printcolors":{printcHighlight:[10,1,1,""],printcLabel:[10,1,1,""],print_color_range:[10,1,1,""],printcWarning:[10,1,1,""],print_color_map:[10,1,1,""],printcSuccess:[10,1,1,""],printc:[10,1,1,""],printcError:[10,1,1,""],print_value:[10,1,1,""],printcInfo:[10,1,1,""],cleancolor:[10,1,1,""],printcHeader:[10,1,1,""]},"src.test_module":{Test:[10,3,1,""],getTmpDirDEFAULT:[10,1,1,""]},"src.ElementTree":{XML:[10,1,1,""],Comment:[10,1,1,""],XMLTreeBuilder:[10,3,1,""],PI:[10,1,1,""],ProcessingInstruction:[10,1,1,""],dump:[10,1,1,""],fromstring:[10,1,1,""],QName:[10,3,1,""],TreeBuilder:[10,3,1,""],Element:[10,1,1,""],parse:[10,1,1,""],iterparse:[10,3,1,""],tostring:[10,1,1,""],SubElement:[10,1,1,""],iselement:[10,1,1,""],ElementTree:[10,3,1,""]},"src.environment.SalomeEnviron":{set:[10,2,1,""],dump:[10,2,1,""],set_products:[10,2,1,""],add_warning:[10,2,1,""],run_env_script:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_comment:[10,2,1,""],prepend:[10,2,1,""],set_python_libdirs:[10,2,1,""],set_application_env:[10,2,1,""],finish:[10,2,1,""],get:[10,2,1,""],get_names:[10,2,1,""],set_a_product:[10,2,1,""],run_simple_env_script:[10,2,1,""],set_cpp_env:[10,2,1,""],set_full_environ:[10,2,1,""],set_salome_minimal_product_env:[10,2,1,""],set_salome_generic_product_env:[10,2,1,""],load_cfg_environment:[10,2,1,""]},"src.xmlManager.XmlLogFile":{write_tree:[10,2,1,""],append_node_attrib:[10,2,1,""],add_simple_node:[10,2,1,""],append_node_text:[10,2,1,""]},"src.pyconf.ConfigOutputStream":{write:[10,2,1,""],close:[10,2,1,""],flush:[10,2,1,""]},"src.template.MyTemplate":{pattern:[10,4,1,""],delimiter:[10,4,1,""]},"src.pyconf.Expression":{evaluate:[10,2,1,""]},"src.__init__":{handleRemoveReadonly:[10,1,1,""],find_file_in_lpath:[10,1,1,""],get_property_in_product_cfg:[10,1,1,""],ensure_path_exists:[10,1,1,""],get_cfg_param:[10,1,1,""],merge_dicts:[10,1,1,""],get_salome_version:[10,1,1,""],activate_mesa_property:[10,1,1,""],read_config_from_a_file:[10,1,1,""],deepcopy_list:[10,1,1,""],SatException:[10,5,1,""],parse_date:[10,1,1,""],get_log_path:[10,1,1,""],get_base_path:[10,1,1,""],Path:[10,3,1,""],replace_in_file:[10,1,1,""],check_config_has_application:[10,1,1,""],remove_item_from_list:[10,1,1,""],config_has_application:[10,1,1,""],check_config_has_profile:[10,1,1,""],get_launcher_name:[10,1,1,""],print_info:[10,1,1,""],only_numbers:[10,1,1,""],get_tmp_filename:[10,1,1,""]},"src.pyconf.ConfigList":{getByPath:[10,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[10,2,1,""],append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],add_warning:[10,2,1,""],finish:[10,2,1,""],prepend:[10,2,1,""],prepend_value:[10,2,1,""],command_value:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.product":{get_product_components:[10,1,1,""],product_is_dev:[10,1,1,""],check_config_exists:[10,1,1,""],get_products_infos:[10,1,1,""],get_base_install_dir:[10,1,1,""],get_product_section:[10,1,1,""],product_is_vcs:[10,1,1,""],product_is_cmake:[10,1,1,""],product_is_smesh_plugin:[10,1,1,""],product_is_fixed:[10,1,1,""],get_install_dir:[10,1,1,""],product_has_salome_gui:[10,1,1,""],check_installation:[10,1,1,""],get_product_dependencies:[10,1,1,""],product_has_script:[10,1,1,""],product_is_native:[10,1,1,""],product_is_salome:[10,1,1,""],product_is_cpp:[10,1,1,""],check_source:[10,1,1,""],product_is_mpi:[10,1,1,""],product_is_generated:[10,1,1,""],product_has_patches:[10,1,1,""],product_has_env_script:[10,1,1,""],get_product_config:[10,1,1,""],product_compiles:[10,1,1,""],product_is_autotools:[10,1,1,""],product_is_debug:[10,1,1,""],product_is_sample:[10,1,1,""],product_has_logo:[10,1,1,""]},"src.__init__.Path":{isdir:[10,2,1,""],smartcopy:[10,2,1,""],copylink:[10,2,1,""],exists:[10,2,1,""],copyfile:[10,2,1,""],make:[10,2,1,""],list:[10,2,1,""],symlink:[10,2,1,""],chmod:[10,2,1,""],copydir:[10,2,1,""],readlink:[10,2,1,""],islink:[10,2,1,""],base:[10,2,1,""],rm:[10,2,1,""],copy:[10,2,1,""],isfile:[10,2,1,""],dir:[10,2,1,""]},"src.colorama.initialise":{deinit:[3,1,1,""],reinit:[3,1,1,""],reset_all:[3,1,1,""],init:[3,1,1,""],wrap_stream:[3,1,1,""],colorama_text:[3,1,1,""]},"src.template":{substitute:[10,1,1,""],MyTemplate:[10,3,1,""]},"src.xmlManager":{append_node_attrib:[10,1,1,""],add_simple_node:[10,1,1,""],write_report:[10,1,1,""],find_node_by_attrib:[10,1,1,""],ReadXmlFile:[10,3,1,""],XmlLogFile:[10,3,1,""]},"src.pyconf.Container":{evaluate:[10,2,1,""],setPath:[10,2,1,""],writeToStream:[10,2,1,""],writeValue:[10,2,1,""]},"src.architecture":{get_distribution:[10,1,1,""],get_distrib_version:[10,1,1,""],get_python_version:[10,1,1,""],is_windows:[10,1,1,""],get_user:[10,1,1,""],get_nb_proc:[10,1,1,""]},"src.colorama.ansi.AnsiBack":{BLUE:[3,4,1,""],RESET:[3,4,1,""],LIGHTBLACK_EX:[3,4,1,""],LIGHTBLUE_EX:[3,4,1,""],LIGHTCYAN_EX:[3,4,1,""],LIGHTWHITE_EX:[3,4,1,""],LIGHTYELLOW_EX:[3,4,1,""],YELLOW:[3,4,1,""],LIGHTRED_EX:[3,4,1,""],BLACK:[3,4,1,""],WHITE:[3,4,1,""],CYAN:[3,4,1,""],GREEN:[3,4,1,""],MAGENTA:[3,4,1,""],LIGHTMAGENTA_EX:[3,4,1,""],LIGHTGREEN_EX:[3,4,1,""],RED:[3,4,1,""]},"src.system":{git_extract:[10,1,1,""],show_in_editor:[10,1,1,""],cvs_extract:[10,1,1,""],svn_extract:[10,1,1,""],archive_extract:[10,1,1,""]},"src.pyconf.Config":{load:[10,2,1,""],removeNamespace:[10,2,1,""],Namespace:[10,3,1,""],addNamespace:[10,2,1,""],getByPath:[10,2,1,""]},"src.colorama.ansi.AnsiFore":{RESET:[3,4,1,""],GREEN:[3,4,1,""],LIGHTBLACK_EX:[3,4,1,""],BLUE:[3,4,1,""],LIGHTCYAN_EX:[3,4,1,""],LIGHTWHITE_EX:[3,4,1,""],LIGHTYELLOW_EX:[3,4,1,""],LIGHTGREEN_EX:[3,4,1,""],YELLOW:[3,4,1,""],LIGHTRED_EX:[3,4,1,""],LIGHTBLUE_EX:[3,4,1,""],BLACK:[3,4,1,""],CYAN:[3,4,1,""],MAGENTA:[3,4,1,""],LIGHTMAGENTA_EX:[3,4,1,""],WHITE:[3,4,1,""],RED:[3,4,1,""]},"src.environment":{load_environment:[10,1,1,""],Shell:[10,3,1,""],Environ:[10,3,1,""],SalomeEnviron:[10,3,1,""],FileEnvWriter:[10,3,1,""]},"src.ElementTree.TreeBuilder":{close:[10,2,1,""],end:[10,2,1,""],start:[10,2,1,""],data:[10,2,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{convert_osc:[3,2,1,""],should_wrap:[3,2,1,""],ANSI_OSC_RE:[3,4,1,""],extract_params:[3,2,1,""],convert_ansi:[3,2,1,""],write_and_convert:[3,2,1,""],get_win32_calls:[3,2,1,""],write:[3,2,1,""],write_plain_text:[3,2,1,""],reset_all:[3,2,1,""],ANSI_CSI_RE:[3,4,1,""],call_win32:[3,2,1,""]},src:{fork:[10,0,1,""],product:[10,0,1,""],template:[10,0,1,""],test_module:[10,0,1,""],compilation:[10,0,1,""],xmlManager:[10,0,1,""],system:[10,0,1,""],environment:[10,0,1,""],pyconf:[10,0,1,""],colorama:[3,0,1,""],"__init__":[10,0,1,""],fileEnviron:[10,0,1,""],debug:[10,0,1,""],logger:[10,0,1,""],ElementTree:[10,0,1,""],options:[10,0,1,""],printcolors:[10,0,1,""],architecture:[10,0,1,""]},"src.xmlManager.ReadXmlFile":{get_attrib:[10,2,1,""],get_node_text:[10,2,1,""],getRootAttrib:[10,2,1,""]},"src.ElementTree.XMLTreeBuilder":{feed:[10,2,1,""],close:[10,2,1,""],doctype:[10,2,1,""]},"src.pyconf":{ConfigMerger:[10,3,1,""],deepCopyMapping:[10,1,1,""],ConfigResolutionError:[10,5,1,""],Container:[10,3,1,""],Reference:[10,3,1,""],ConfigReader:[10,3,1,""],Config:[10,3,1,""],makePath:[10,1,1,""],defaultStreamOpener:[10,1,1,""],overwriteMergeResolve:[10,1,1,""],Mapping:[10,3,1,""],defaultMergeResolve:[10,1,1,""],ConfigFormatError:[10,5,1,""],ConfigError:[10,5,1,""],Sequence:[10,3,1,""],ConfigList:[10,3,1,""],ConfigInputStream:[10,3,1,""],Expression:[10,3,1,""],isWord:[10,1,1,""],ConfigOutputStream:[10,3,1,""]},"src.pyconf.Sequence.SeqIter":{next:[10,2,1,""]},"src.options.Options":{print_help:[10,2,1,""],add_option:[10,2,1,""],parse_args:[10,2,1,""]},"src.ElementTree.iterparse":{next:[10,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[10,2,1,""],merge:[10,2,1,""],mergeMapping:[10,2,1,""],overwriteKeys:[10,2,1,""],mergeSequence:[10,2,1,""]},"src.colorama.winterm.WinColor":{BLUE:[3,4,1,""],GREEN:[3,4,1,""],GREY:[3,4,1,""],YELLOW:[3,4,1,""],BLACK:[3,4,1,""],CYAN:[3,4,1,""],MAGENTA:[3,4,1,""],RED:[3,4,1,""]},"src.logger":{timedelta_total_seconds:[10,1,1,""],show_command_log:[10,1,1,""],update_hat_xml:[10,1,1,""],date_to_datetime:[10,1,1,""],list_log_file:[10,1,1,""],Logger:[10,3,1,""]},"src.pyconf.Reference":{findConfig:[10,2,1,""],resolve:[10,2,1,""],addElement:[10,2,1,""]},"src.colorama.ansitowin32":{is_a_tty:[3,1,1,""],AnsiToWin32:[3,3,1,""],StreamWrapper:[3,3,1,""],is_stream_closed:[3,1,1,""]},"src.colorama.ansi.AnsiCursor":{DOWN:[3,2,1,""],FORWARD:[3,2,1,""],UP:[3,2,1,""],BACK:[3,2,1,""],POS:[3,2,1,""]},"src.environment.Environ":{append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],prepend:[10,2,1,""],prepend_value:[10,2,1,""],command_value:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""]},"src.test_module.Test":{run_all_tests:[10,2,1,""],search_known_errors:[10,2,1,""],run_script:[10,2,1,""],generate_launching_commands:[10,2,1,""],prepare_testbase:[10,2,1,""],run_tests:[10,2,1,""],generate_script:[10,2,1,""],run_session_tests:[10,2,1,""],prepare_testbase_from_svn:[10,2,1,""],run_grid_tests:[10,2,1,""],prepare_testbase_from_dir:[10,2,1,""],write_test_margin:[10,2,1,""],run_testbase_tests:[10,2,1,""],get_test_timeout:[10,2,1,""],get_tmp_dir:[10,2,1,""],prepare_testbase_from_git:[10,2,1,""],read_results:[10,2,1,""]},"src.debug":{tofix:[10,1,1,""],saveConfigDbg:[10,1,1,""],indent:[10,1,1,""],getStrConfigStd:[10,1,1,""],getStrConfigDbg:[10,1,1,""],saveConfigStd:[10,1,1,""],pop_debug:[10,1,1,""],OutStream:[10,3,1,""],push_debug:[10,1,1,""],write:[10,1,1,""],InStream:[10,3,1,""],getLocalEnv:[10,1,1,""]},"src.colorama.ansi":{AnsiBack:[3,3,1,""],AnsiStyle:[3,3,1,""],set_title:[3,1,1,""],code_to_chars:[3,1,1,""],clear_screen:[3,1,1,""],AnsiCodes:[3,3,1,""],AnsiCursor:[3,3,1,""],AnsiFore:[3,3,1,""],clear_line:[3,1,1,""]},"src.compilation.Builder":{wmake:[10,2,1,""],do_script_build:[10,2,1,""],do_python_script_build:[10,2,1,""],cmake:[10,2,1,""],configure:[10,2,1,""],prepare:[10,2,1,""],make:[10,2,1,""],put_txt_log_in_appli_log_dir:[10,2,1,""],hack_libtool:[10,2,1,""],build_configure:[10,2,1,""],do_default_build:[10,2,1,""],complete_environment:[10,2,1,""],install:[10,2,1,""],log_command:[10,2,1,""],do_batch_script_build:[10,2,1,""],check:[10,2,1,""],log:[10,2,1,""]}},terms:{represent:10,all:[1,2,3,7,10,11,13,9,15,18],code:[9,0,10,3],node:10,forget:10,xxx_src_dir:10,is_defin:10,global:10,dollar:10,install_dir:9,yellow:3,printcsuccess:10,known:6,scalar:10,printchighlight:10,product_compil:10,get_tmp_filenam:10,append_node_text:10,follow:[9,10,18],mon:10,colorama_text:3,get_nb_proc:10,getlocalenv:10,decid:10,typeerror:10,depend:[8,6,10],system:[5,6,10],"_debug":10,mergesequ:10,parsesequ:10,show:[8,10,17],gencat:[14,12],dict_arg:10,yve:10,supposedli:10,openmpi:10,adot:10,tofix:10,get_products_info:10,"0x35b8810":[],xxx_root_dir:10,suitabl:10,ignorelist:10,sourc:[1,3,6,7,10,11,13],string:10,without:[1,10,11],fals:[10,3],winstyl:3,welkom:10,util:[0,6,10],print:[10,11,17,3],mechan:[9,10],get_attrib:10,word:10,run_test:10,syntax:[10,15,13],strout:10,get_method:1,isdir:10,dim:3,set_full_environ:10,interact:17,contextfileenviron:10,hour:10,harri:10,yyyymmdd_hhmmss_namecmd:10,gui:10,cmd:10,list:[0,7,10,11,12,13,14,15],prefix:[9,10,15],iter:10,correct:10,"try":10,item:10,printcwarn:10,has_salome_hui:10,stderr:10,tostr:10,sajip:10,initialis:[5,10,3],dir:[1,10,11],ansistyl:3,pleas:[9,2],smaller:10,eearch:10,cfg:[9,10,18],my_tag:1,pubid:10,transform:10,sign:10,second:[9,10,18],atitl:10,design:10,list_log_fil:10,download:[1,10],iostream:10,setconsoletextattribut:3,salometool:[0,4,6,7,10,11,12,9,15,18],append:[9,6,10],yacsgen:[10,2],compat:10,index:10,what:[10,13],copyfil:10,salomecontext:10,sub:[10,15],section:[9,1,10,12,15],access:[10,18,3,17],delet:6,version:[9,15,6,2,10],product2:[8,9,1],product1:[8,9,1],parsefactor:10,"new":[1,10,18],defaultstreamopen:10,method:[1,3,8,10,9,18],get_test_timeout:10,optresult:10,xml:[10,18],full:10,deriv:10,iteritem:10,vinai:10,usag:[0,1,2,6,7,8,9,10,11,12,13,14,17],gener:[0,2,3,7,9,10,12,14],set_a_product:10,here:[9,10,15,18],ansicod:3,product_is_autotool:10,ansitowin32:[5,10,3],path:[1,6,8,9,10,11,12,13,14,17],modifi:[9,1,10],sinc:10,valu:[1,3,10,11,12,13,15],machine2:12,handleremovereadonli:10,search:10,lome:0,is_stream_clos:3,launcher_nam:14,env_launch:9,mergemap:10,set_salome_minimal_product_env:10,datetim:10,amount:10,get_product_depend:10,bom:10,load_environ:10,action:10,timedelta_total_second:10,chang:[10,7,18,12],script_nam:10,commonli:10,control:6,show_progress:10,configur:[0,1,6,8,9,10,11,12,13,14,15,17,18],test_sess:10,do_python_script_build:10,extra:10,wai:[8,10,18],"_sre":[10,3],modul:[0,1,2,3,5,8,10,12,14,15],wil:9,prefer:[15,11],getrootattrib:10,activate_mesa_properti:10,filenam:10,printc:10,"boolean":[10,18],product_is_vc:10,home:11,instal:[0,7,8,10,13,15,4],text_or_uri:10,unit:8,getchar:10,do_default_build:10,test_nam:10,parma:10,from:[1,2,3,6,10,11,9,18],tar:[6,4],would:10,memori:[14,12],subtract:10,stdout:[10,3],show_command_log:10,next:10,lightred_ex:3,process:1,product_is_smesh_plugin:10,program:10,call:[14,9,10,18,3],addnamespac:10,handl:[9,10,3],taken:[9,10],tcllibpath:10,isel:10,type:[1,10],lost:10,varsto:[],componon:2,get_nam:10,ool:0,under:[0,10],mismatch:10,award:10,author:10,warn:[8,0,1,10],flag:8,load_cfg_environ:10,particular:10,mydebug:10,lpath:10,check_src:10,hold:14,futur:10,must:[10,18],command_nam:10,none:[10,3],join:9,get_property_in_product_cfg:10,restor:[10,13],abool:10,prepar:[0,1,10,7,18],work:[1,6,11,15,10],subel:10,dev:[1,10],product_is_cmak:10,remain:[17,4],archiv:[1,6,10],obvious:10,can:[0,1,10,12,9,15,18],print_info:10,sommeil:10,nb_line:10,configresolutionerror:10,root:[10,18],could:[9,10,4,13],def:[9,10,18],appropri:10,overrid:[10,12],overwritten:10,write_back:10,want:[9,10,13,18],stream:[10,3],give:[15,10,12,18],add_warn:10,prepare_testbas:10,hxx2salom:2,templat:[5,10],path_to_yacsgen:2,smartcopi:10,bienvenu:10,tag:[1,10],explor:11,search_known_error:10,magenta:3,keep:10,occur:10,cleancolor:10,delai:10,end:[9,10,3],directori:[1,4,6,7,8,9,10,11,12,13,14,15,17,18],secur:1,programmat:9,anoth:[10,15],add_simple_nod:10,env_script:9,gettmpdir:10,divis:10,how:[9,1,10,15],remove_item_from_list:10,"__init__":10,env:9,deepcopy_list:10,token_valu:10,config:[0,1,7,10,11,15,18],parsemap:10,virtual_app:12,updat:10,processinginstruct:10,product:[0,1,2,5,6,7,8,9,10,11,13,14,15,18],get_log_path:10,configlist:10,timedelta:10,max:10,clone:1,after:[8,10,4],defaultmergeresolv:10,befor:[8,10],catalog:[14,12],date:[10,15],multipl:10,mesa:[14,10,12],getbypath:10,data:[10,11,18],get_python_vers:10,wmake:10,test_modul:[5,10],circumst:10,"short":10,four:9,get_us:10,ensure_path_exist:10,filepath:10,favorit:11,correspond:[9,1,10,17],cvspass:1,element:10,map2:10,inform:[1,6,11,15,10],wincolor:3,green:3,block:[],allow:[0,2,7,8,10,11],prod_dir:10,callabl:10,set_attr:3,generate_launching_command:10,order:[1,10,15,18],configoutputstream:10,salom:[0,2,6,7,8,9,10,11,12,13,14,15,4],tty:3,merge_dict:10,softwar:1,lanch:10,str_num:10,hack_libtool:10,seqit:10,through:[14,9,12,17],same:10,cyan:3,hierarchi:10,afil:10,pretti:10,dynam:15,paramet:[10,11,15,18],raw:10,write:[10,18,3],style:[10,3],cli:[17,7],clean_instal:8,amethodtodebug:10,fix:10,test_base_nam:10,platform:[9,3],window:[9,10,3],pend:13,find_node_by_attrib:10,requir:[18,9,10,2,3],strin:10,wrap_stream:3,main:8,fin:10,alter:1,add_echo:10,cvs_info:1,them:[1,3],within:9,"return":[9,10,18],thei:[9,1,11,13],python:[0,9,10,4,14,15,18],obtain:10,"export":1,dai:10,initi:10,with_install_dir:10,more:[10,7],configformaterror:10,instead:10,nor:3,introduct:18,choic:11,term:10,document:[0,15,2,18],init:[10,3],name:[1,6,7,9,10,11,12,13,14,15,18],edit:[1,11],getiter:10,parsescalar:10,makepath:10,yyyymmdd_hhmmss:10,authent:1,win32:[5,10,3],merge:10,token:10,inmap:10,mode:[1,3,7,10,11,13,9,17],each:[14,1,10,12,15],debug:[1,5,7,10,11,9],found:10,unicod:10,clean_build_aft:8,splashscreen:14,checkout:[1,10],compil:[0,1,2,5,7,8,10,9,17],seq1:10,git:[1,6,10],prepend_valu:10,stop_first_fail:8,replac:[10,12],read_config_from_a_fil:10,hard:10,continu:10,procedur:10,handlemismatch:10,wrap:3,show_patch:11,workdir:[6,7,10,11,12,14,15,18],expect:10,satexcept:10,year:10,distrib:10,resourc:[14,12],extract:10,event:10,check_config_exist:10,out:10,variabl:[9,10,2,18],shown:[8,10],"_ld_library_path":9,get_node_text:10,pyconf:[1,5,8,10,11,9,15,18],goe:10,optionali:10,dst:10,salomeenviron:10,findtext:10,profil:[14,10],geom:8,log_dir:17,rel:[6,10],reader:10,configread:10,ref:10,factori:10,red:[10,3],file_nam:10,multilin:10,model:18,earlier:10,get_salome_vers:10,proxi:3,run_all_test:10,advanc:10,update_hat_xml:10,manipul:[10,11],updatehatxml:10,env_info:10,command_opt:7,printchead:10,quick:0,bright_background:3,base:[1,10,15,3],pendant:10,dictionari:[10,15],usual:[2,6,7,13,15,4],put:10,longnam:10,earliest:10,copylink:10,bash:[9,1,10],care:13,thrown:10,additional_dir:10,indent:10,"_blank":10,launch:[9,10],argument:[10,18],zerodivideerror:10,ask:10,david:10,filter:13,thing:18,"int":[10,17],rais:[10,7],unabl:10,temporari:10,screenenviron:10,file_path:10,assign:10,first:[9,1,10,18],feed:10,"0x3620700":[],rang:10,read_result:10,suffix:10,directli:[9,17,4],kernel:[11,7],carri:10,onc:1,number:[8,14,10,12,17],"0x24c9d70":10,echo:10,get_tmp_dir:10,instruct:[10,15],alreadi:[6,18],done:[9,7],messag:[10,18],visualis:9,miss:[8,12],underscor:[9,10],size:10,date_to_datetim:10,differ:9,"long":[10,13],ansi_osc_r:3,printclabel:10,script:[0,8,9,10,11,14,15,4],overwritekei:10,arch:6,top:10,sometim:13,construct:[0,10,16],archive_extract:10,setstream:10,termin:[8,10,18,3,17],white:3,put_txt_log_in_appli_log_dir:10,get_launcher_nam:10,"final":[1,10,11],store:[1,8,10,11,15,17],myspecificnam:6,my_appli_directori:[],shell:[9,10],consol:10,option:[1,2,3,5,6,7,8,9,10,11,12,13,14,15,17,18],root_nod:10,product_is_sampl:10,tool:0,shallow:10,product_has_script:10,print_color_map:10,specifi:[1,2,9,10,12,14],micro_command:10,jane:10,gitconfig:1,pars:[10,18],printcerror:10,git_info:1,exactli:10,grep:11,target:[9,10,12],whenev:10,provid:[9,10,18],remov:[8,1,10,13],eleg:10,nb_proc:[8,10],zero:10,structur:15,charact:[10,3],project:[9,11],prepare_testbase_from_svn:10,info:[1,10,11],includ:[9,6,15,10],str:10,set_product:10,posit:3,findconfig:10,minut:10,other:[9,15,6,10,18],make_opt:10,grei:3,browser:[10,11,17,15],do_script_build:10,comput:[6,2,10],additional_env:10,runner:18,check_config_has_profil:10,pass:[10,15,18],ani:[1,10,11,17,3],elem:10,silent_sysstd:10,config_has_appl:10,himself:9,openggl:[14,12],have:[1,2,10,12,13,14],tabl:10,need:[1,10,2,3,12],seen:10,notimplementederror:10,turn:10,pythonpath_:9,erase_screen:3,implement:[9,10,3],issu:3,build_configur:10,get_file_environ:10,is_window:10,lib:9,cli_:18,latter:10,set_consol:3,out_dir:10,force_patch:1,note:[0,1,2,6,8,9,10,11,12,14,15,16,18],also:[9,1,10,15,18],preced:10,filein:10,indic:10,environ:[0,2,5,10,9,15],lightmagenta_ex:3,noth:[6,10],blue:3,begin:10,winterm:[5,10,3],unless:[1,3],distribut:[10,2,12],clash:10,testbase_dir:10,usernam:10,end_writ:10,previou:10,compress:6,deleg:3,successfulli:10,streamorfil:10,has_timed_out:10,most:[9,10,18],param_nam:10,colorama:[5,10,3],all_in_termin:10,phase:10,logfilepath:10,paramstr:3,"class":[10,18,3],charg:14,"_build":9,put_initial_xml_field:10,"0x2379de8":10,product_is_cpp:10,exc:10,ansi_csi_r:3,alphanumer:10,full_launched_command:10,request:3,drive:10,push_debug:10,doe:[9,1,10],tklibpath:10,product_cfg:10,set_salome_generic_product_env:10,declar:1,ruud:10,cursor_adjust:3,determin:10,sources_without_dev:13,enclos:10,shortnam:10,unchang:10,notion:10,dot:10,forbuild:10,getstrconfigstd:10,use_mesa:[14,12],set:[0,9,10,12,13,14,15,18],set_cursor_posit:3,"16be":10,last_termin:17,batfileenviron:10,text:[10,7,3],autoreset:3,convert_osc:3,dbg:10,name_nod:10,bring:[1,2],bright:3,optiontyp:10,input_list:10,"0x34bc7d0":[],dirpath:10,identifi:10,token_typ:10,find:[10,11,4],help:[10,7,18],redirect:10,current:[15,10,11,7,18],onli:[1,2,7,8,9,10,11,12,13,14,17],explicitli:10,locat:10,execut:[8,1,10,7],copyright:10,menu:17,explain:9,complete_environ:10,releas:[0,16],configut:12,pluma:15,should:[9,10,2],reinit:[10,3],run_grid_test:10,far:10,extract_param:3,logdir:10,factor:10,virtual:[10,12],local:11,obj1:10,reset:3,obj2:10,append_node_attrib:10,a_b_c_:10,get:[1,7,10,11,15,18],lightwhite_ex:3,convert:3,express:[10,11],stop:8,account:9,configmerg:10,nativ:[9,10],cannot:10,yourspecificnam:6,ssh:[14,1,12],write_plain_text:3,destnam:10,report:10,parsemappingbodi:10,set_python_libdir:10,path_to_catalog:12,product_is_salom:10,log_file_nam:10,env_build:9,bat:[9,10],"16le":10,non:3,specif:[2,6,7,9,10,12,13,14,15],instanti:10,multi:10,yield:10,patch:[1,10,11],runappli:12,stuff:[14,10],bashfileenviron:10,common:10,contain:[10,15,18],avari:10,script_path:10,llvm:[14,12],where:[8,6,11,12,10],instream:10,product_has_logo:10,black:3,wiki:3,conform:2,python_config:10,saveconfigdbg:10,seq:10,sep:[9,10],listtest:10,xc2:10,change_to_launch:10,namespac:10,see:[15,10,7,3],"9abc":10,remor:2,arg:[10,18,3],fail:[8,10],close:10,stack:7,arglist:10,becaus:10,servic:18,isword:10,concern:1,statu:10,detect:10,parent:10,co7:6,deinit:3,pattern:10,wikipedia:3,label:[10,11],write_cfgforpy_fil:10,urlopen:10,written:18,zelaunch:14,between:[10,18],progress:10,parsevalu:10,"0x3ff4610":3,with_vc:6,attribut:[10,3],attibut:10,verifi:[1,10],kei:[9,1,10],node_nam:10,exampl:[0,1,6,7,8,10,11,13,9,18],on_stderr:3,popul:10,extens:[10,18],job:8,parameter_path:11,french:18,printcolor:[5,10],complementari:9,distinguish:9,writevalu:10,come:11,problem:[14,10,12],regular:10,addit:[8,10,15],verbos:[10,7,18],both:[9,10,2],mond:18,last:[9,10,17],delimit:10,rtype:10,list_of_product:2,equal:8,cfgforpi:10,build_conf_opt:10,etc:[0,10,15],no_label:11,instanc:[10,18,3],tout:18,context:[10,7],pdf:11,login:1,sre_pattern:[10,3],ld_library_path:9,comment:[10,15],find_file_in_lpath:10,getroot:10,lightblue_ex:3,test_grid:10,point:[10,18],tgz:[6,4],git_extract:10,chmod:10,map1:10,svn_info:1,header:10,streamopen:10,product_is_gener:10,add_link:10,shortcut:10,print_color_rang:10,ioerror:10,get_product_sect:10,mistak:1,configure_opt:10,assum:10,src_root:10,cmake_opt:8,product_has_env_script:10,set_env_build:9,light:3,check_sourc:10,creat:[0,1,6,9,10,12,13,14,15],deep:10,machine1:12,classic:10,due:10,empti:10,otherwis:[1,10],compon:[10,2,12],viewer:11,machine3:12,basic:18,buf:10,product_is_mpi:10,cwd:10,lightgreen_ex:3,show_warn:10,salome_session_serv:10,parser:[10,18],launcherfileenviron:10,presenc:10,imag:1,xxx:[15,13],remark:[1,2,12],dict:10,clear_lin:3,findal:10,dixt:10,func:10,els:[10,18],print_valu:10,testbase_bas:10,bonjour:18,logger:[5,10,18],those:2,prereq_dir:9,"case":10,get_cfg_param:10,set_titl:3,ident:10,lapack_root_dir:9,packag:[0,3,5,6,10,4],launcher:[14,0,10,12,9],intal:6,set_env:[9,10],properti:[9,10,2,13],pop_debug:10,qname:10,aim:10,defin:[2,8,10,11,13,9,15,18],smart:10,behavior:18,error:10,fun:11,exist:[1,6,10,7],gettoken:10,exot:10,fileenviron:[5,10],subsect:9,element_factori:10,layer:2,only_numb:10,add_com:10,my_application_nam:12,lightcyan_ex:3,readi:1,affect:3,trust_root_dir:9,site:10,generate_script:10,activ:[1,10],"default":[1,6,7,8,9,10,11,12,14,17,18],kwarg:3,default_valu:10,eras:17,myapp:[],product_nam:10,get_product_config:10,ascii:10,sever:[9,15],result:10,complet:[8,1,15,11],xa4:10,develop:[0,1,10,11,13,9,18],welcom:10,open:10,minim:10,perform:[0,1],make:[8,10],belong:10,notshowncommand:10,delaiapp:10,write_env_fil:10,binari:6,tutori:10,from_what:10,xmllogfil:10,batch_salom:10,pprty:10,sat:[0,1,2,4,6,7,8,9,10,11,12,13,14,15,17,18],setpath:10,check_config_has_appl:10,conflict:10,yacsgen_root_dir:2,exhaust:[15,7],"__save__":10,http:[10,3],svn_extract:10,closest:10,getstrconfigdbg:10,oper:[0,10,11],someon:9,salome_xx:[6,13,7,4],remot:[6,10],mycommand:18,write_test_margin:10,user:[6,7,10,11,4,9,15,17,18],applic:[0,1,2,8,9,10,11,12,13,14,15,17,18],seq2:10,readlink:10,set_cpp_env:10,preset:10,built:10,subpackag:[5,10],lproduct:10,redefin:10,code_block:[],older:17,com:10,builder:10,cpp:[10,2],well:10,for_packag:10,given:[14,9,10,12,3],erase_lin:3,person:11,append_valu:10,client:10,launch_command:10,ansicursor:3,thi:[0,1,2,3,6,8,9,10,11,12,14,15,18],convert_ansi:3,everyth:8,"0x245afd0":10,self:10,left:9,load:[10,15],with_children:8,protocol:[10,12],entri:10,just:[8,10],object:[10,15,3],template_fil:10,deepcopymap:10,semant:10,reserv:10,detail:10,insid:1,gdb:9,via:10,distant:12,parsesuffix:10,world:18,firefox:[15,17],passphras:1,prepend:[9,10],opt_nb_proc:10,yet:7,lightyellow_ex:3,screenonli:10,web:[15,11,17],like:[3,8,10,11,12,14,15],run_testbase_test:10,smesh:10,removenamespac:10,addmap:10,lapack:9,tmp_working_dir:10,number_of_proc:10,prod_info:10,had:10,outstream:10,param:[10,3],streamwrapp:3,etre:10,add:[8,0,10,18],detar:4,astream:10,nfirst:10,appli:[1,10,11,2],input:10,get_attr:3,save:9,hat:10,match:10,build:[7,8,10,13,9,15],bin:9,show_in_editor:10,which:[2,3,10,9,15,18],fileenvwrit:10,format:[9,10,15],read:10,big:8,write_and_convert:3,get_install_dir:10,howto:18,blogmatrix:10,regard:10,copydir:10,get_win32_cal:3,enable_simple_env_script:10,were:10,grid:10,backtick:10,dir_info:1,part:[14,9,10,12],password:1,recurs:[10,11],color:[10,3],apart:3,application_nam:12,xmlmanag:[5,10],xmltreebuild:10,med:8,ivar:10,write_tre:10,success:[8,10],testbase_tag:10,special_path_separ:10,get_distribut:10,html:10,dove:10,showinfo:10,api:10,either:[9,10],readxmlfil:10,parserefer:10,plugin:[8,10],output:[10,3],page:9,two:[9,10],yyyi:10,run_session_test:10,iterpars:10,right:[9,10],old:10,who:2,overwritemergeresolv:10,copi:[14,10,11,12,7],creation:6,simpl:[10,7,18],back:3,resolv:10,isfil:10,intern:10,adequ:10,sampl:[10,7],respect:9,ansifor:3,indirect:10,server:[1,10],bigger:10,killsalom:10,librari:10,replace_in_fil:10,separ:10,"__setattr__":10,txt:10,trace:7,except:[1,10,7],"function":[10,18,3],test_config:10,normal:[10,3],definit:10,thank:10,subclass:10,testbas:10,when:[1,10,12,9,15,18],substitut:10,select:6,product_info:10,add_lin:10,duplic:8,product_has_salome_gui:10,islink:10,refer:[10,2,15],machin:[14,6,2,10,12],reflect:10,lightblack_ex:3,print_help:10,run:[9,0,10,15,18],run_script:10,tree:10,my_application_directori:12,reset_al:3,xmlroot:10,symlink:10,"_launch":9,step:10,get_base_path:10,ansiback:3,repositori:[1,10],log_command:10,code_to_char:3,don:2,prepare_testbase_from_git:10,describ:10,session:10,src:[5,10,18,3],about:[10,15],actual:[10,4,3],cfg_env:10,get_posit:3,column:10,writetostream:10,parsekeyvaluepair:10,manag:[1,10,11],total_second:10,map:10,rootnam:10,winapi_test:3,act:[10,3],commit:13,attrib:10,mytempl:10,without_properti:6,produc:10,corba:2,paravi:[14,12],subset:6,own:10,absolut:6,logo:[14,10],pythonpath:9,product_is_dev:10,"float":10,encod:10,www:10,automat:[9,11],subst_dic:10,down:3,pair:10,make_flag:8,parse_d:10,run_env_script:10,product_is_fix:10,strip:3,command_valu:10,"import":[9,10,18],batch:10,soon:8,your:[9,1,10,7,18],transpar:3,merg:10,set_native_env:[9,10],processor:[14,10,12],get_base_install_dir:10,log:[8,0,10,17,18],suffici:9,support:10,get_distrib_vers:10,stylesheet:10,overwrit:10,custom:18,avail:[11,13,7],start:[0,3,8,10,12,14],again:10,been:[10,3],interfac:[10,7],editor:[10,11,15],suit:0,"var":[9,10,15,18],printcinfo:10,parse_arg:[10,18],run_simple_env_script:10,usr:9,fork:[5,10],autotool:[8,10],doctyp:10,agent:1,ansi_escape_cod:3,form:10,forc:[1,6,10],tupl:10,fmt:10,prerequisit:[9,0,6,15,7],fore:3,forward:[14,12,3],pwd:10,commentari:10,testbase_nam:10,delta:10,renam:10,line:[10,11,7],level:[10,7,18],"true":[10,3],dump:10,iterkei:10,concaten:10,utf:[9,10],attr:[10,3],consist:10,possibl:[9,1,10,18],new_nam:11,saveconfigstd:10,take:[10,13],displai:[8,10,11,17,18],previous:13,archive_info:1,below:9,get_product_compon:10,ensur:10,mai:1,do_batch_script_build:10,product_is_debug:10,highlight:10,readlin:10,gettmpdirdefault:10,similar:10,unconditionali:[10,7],later:6,evalu:10,product_is_n:10,pv_plugin_path:10,retriev:10,dure:1,flush:10,build_sourc:8,command:[0,1,2,3,4,6,7,8,9,10,11,12,13,14,15,17,18],kwd:3,repres:10,"char":10,operand:10,fromstr:10,"0x42d2cf0":3,set_application_env:10,file:[0,1,6,8,9,10,11,12,14,15,17,18],our:3,some:[1,6,8,9,10,11,12,13,14,15,17,18],salome_xx_:6,show_desktop:10,cvs_extract:10,check:[8,9,10],link:[1,10],bracket:10,tab:10,should_wrap:3,cmake:[8,10],know:[1,10],with_commerci:10,is_a_tti:3,titl:[10,3],renint:10,elementtre:[5,10],invalid:10,configinputstream:10,field:10,finish:10,valid:10,bool:10,parseterm:10,branch:1,suppress:13,writabl:10,you:[0,1,9,10,12,13,14,18],product_has_patch:10,clean_al:[8,7],test:[8,0,10],architectur:[5,6,15,10],correl:10,treebuild:10,configerror:10,resolut:10,command_r:10,clean:[8,0,10,17,13],yyi:15,stringio:10,sequenc:[10,3],org:3,urllib2:10,ansi:[5,10,3],prepare_testbase_from_dir:10,queri:[14,12],embed:6,eval:10,set_env_launch:9,helpstr:10,write_report:10,call_win32:3,salome_modul:10,svn:[1,6,10],addel:10,with_fath:8,algorithm:18,"_appli":12,add_opt:[10,18],descript:[1,2,6,8,9,10,11,12,13,14,15,17,18],compil_script:8,hello:18,is_salome_modul:[9,13],check_instal:10,clear_screen:3,ignor:[10,2],fact:18,potenti:10,time:[9,1,10,15,13],push:1,generic_opt:7,avoid:1,myoption:18},objtypes:{"0":"py:module","1":"py:function","2":"py:method","3":"py:class","4":"py:attribute","5":"py:exception"},titles:["Salome Tools","Command prepare","Command generate","colorama Package","Installation","src","Command package","Usage of SAlomeTools","Command compile","Command environ","src Package","Command config","Command application","Command clean","Command launcher","Configuration","Release notes","Command log","Add a user custom command"],objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"],"5":["py","exception","Python exception"]},filenames:["index","commands/prepare","commands/generate","commands/apidoc/src.colorama","installation_of_sat","commands/apidoc/modules","commands/package","usage_of_sat","commands/compile","commands/environ","commands/apidoc/src","commands/config","commands/application","commands/clean","commands/launcher","configuration","release_notes/release_notes_5.0.0","commands/log","write_command"]})
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Usage of SAlomeTools — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+ <link rel="next" title="Command config" href="commands/config.html" />
+ <link rel="prev" title="Configuration" href="configuration.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="usage-of-salometools">
+<h1>Usage of SAlomeTools<a class="headerlink" href="#usage-of-salometools" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>sat usage is a Command Line Interface (<a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a>).</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat <span class="o">[</span>generic_options<span class="o">]</span> <span class="o">[</span><span class="nb">command</span><span class="o">]</span> <span class="o">[</span>product<span class="o">]</span> <span class="o">[</span>command_options<span class="o">]</span>
+</pre></div>
+</div>
+<div class="section" id="options-of-sat">
+<h3>Options of sat<a class="headerlink" href="#options-of-sat" title="Permalink to this headline">¶</a></h3>
+<p>Useful <em>not exhaustive</em> generic options of <em>sat</em> CLI.</p>
+<div class="section" id="help-or-h">
+<h4><em>--help or -h</em><a class="headerlink" href="#help-or-h" title="Permalink to this headline">¶</a></h4>
+<p>Get help as simple text.</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat --help <span class="c"># get the list of existing commands</span>
+sat --help compile <span class="c"># get the help on a specific command 'compile'</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="debug-or-g">
+<h4><em>--debug or -g</em><a class="headerlink" href="#debug-or-g" title="Permalink to this headline">¶</a></h4>
+<p>Execution in debug mode allows to see more trace and <em>stack</em> if an exception is raised.</p>
+</div>
+<div class="section" id="verbose-or-v">
+<h4><em>--verbose or -v</em><a class="headerlink" href="#verbose-or-v" title="Permalink to this headline">¶</a></h4>
+<p>Change verbosity level (default is 3).</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># for product 'SALOME_xx' for example</span>
+<span class="c"># execute compile command in debug mode with trace level 4</span>
+sat -g -v 4 compile SALOME_xx
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+<div class="section" id="build-a-salome-product">
+<h2>Build a SALOME product<a class="headerlink" href="#build-a-salome-product" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="get-the-list-of-available-products">
+<h3>Get the list of available products<a class="headerlink" href="#get-the-list-of-available-products" title="Permalink to this headline">¶</a></h3>
+<p>To get the list of the current available products in your context:</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat config --list
+</pre></div>
+</div>
+</div>
+<div class="section" id="prepare-sources-of-a-product">
+<h3>Prepare sources of a product<a class="headerlink" href="#prepare-sources-of-a-product" title="Permalink to this headline">¶</a></h3>
+<p>To prepare (get) <em>all</em> the sources of a product (<em>SALOME_xx</em> for example):</p>
+<div class="highlight-bash"><div class="highlight"><pre>sat prepare SALOME_xx
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line">The sources are usually copied in directories</div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name</em></div>
+</div>
+</div>
+<div class="section" id="compile-salome">
+<h3>Compile SALOME<a class="headerlink" href="#compile-salome" title="Permalink to this headline">¶</a></h3>
+<p>To compile products:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># compile all prerequisites/products</span>
+sat compile SALOME_xx
+
+<span class="c"># compile only 2 products (KERNEL and SAMPLES), if not done yet</span>
+sat compile SALOME_xx --products KERNEL,SAMPLES
+
+<span class="c"># compile only 2 products, unconditionaly</span>
+sat compile SALOME_xx ---products SAMPLES --clean_all
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line">The products are usually build in the directories</div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name</em></div>
+<div class="line"><br /></div>
+<div class="line">The products are usually installed in the directories</div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name</em></div>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Usage of SAlomeTools</a><ul>
+<li><a class="reference internal" href="#usage">Usage</a><ul>
+<li><a class="reference internal" href="#options-of-sat">Options of sat</a><ul>
+<li><a class="reference internal" href="#help-or-h"><em>--help or -h</em></a></li>
+<li><a class="reference internal" href="#debug-or-g"><em>--debug or -g</em></a></li>
+<li><a class="reference internal" href="#verbose-or-v"><em>--verbose or -v</em></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#build-a-salome-product">Build a SALOME product</a><ul>
+<li><a class="reference internal" href="#get-the-list-of-available-products">Get the list of available products</a></li>
+<li><a class="reference internal" href="#prepare-sources-of-a-product">Prepare sources of a product</a></li>
+<li><a class="reference internal" href="#compile-salome">Compile SALOME</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="configuration.html" title="previous chapter">Configuration</a></li>
+ <li>Next: <a href="commands/config.html" title="next chapter">Command config</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/usage_of_sat.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="_sources/usage_of_sat.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Add a user custom command — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
+ <link rel="next" title="src" href="commands/apidoc/modules.html" />
+ <link rel="prev" title="Command generate" href="commands/generate.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="add-a-user-custom-command">
+<h1>Add a user custom command<a class="headerlink" href="#add-a-user-custom-command" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="introduction">
+<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This documentation is for <a class="reference external" href="https://docs.python.org/2.7">Python</a> developers.</p>
+</div>
+<p>The salomeTools product provides a simple way to develop commands.
+The first thing to do is to add a file with <em>.py</em> extension in the <tt class="docutils literal"><span class="pre">commands</span></tt> directory of salomeTools.</p>
+<p>Here are the basic requirements that must be followed in this file in order to add a command.</p>
+</div>
+<div class="section" id="basic-requirements">
+<h2>Basic requirements<a class="headerlink" href="#basic-requirements" title="Permalink to this headline">¶</a></h2>
+<p>By adding a file <em>mycommand.py</em> in the <tt class="docutils literal"><span class="pre">commands</span></tt> directory, salomeTools will define a new command named <tt class="docutils literal"><span class="pre">mycommand</span></tt>.</p>
+<p>In <em>mycommand.py</em>, there must be the following method:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="c"># your algorithm ...</span>
+ <span class="k">pass</span>
+</pre></div>
+</div>
+<p>In fact, at this point, the command will already be functional.
+But there are some useful services provided by salomeTools :</p>
+<ul class="simple">
+<li>You can give some options to your command:</li>
+</ul>
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">src</span>
+
+<span class="c"># Define all possible option for mycommand command : 'sat mycommand <options>'</span>
+<span class="n">parser</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">Options</span><span class="p">()</span>
+<span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">'m'</span><span class="p">,</span> <span class="s">'myoption'</span><span class="p">,</span> \
+ <span class="s">'boolean'</span><span class="p">,</span> <span class="s">'myoption'</span><span class="p">,</span> \
+ <span class="s">'My option changes the behavior of my command.'</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="c"># Parse the options</span>
+ <span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+ <span class="c"># algorithm</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li>You can add a <em>description</em> method that will display a message when the user will call the help:</li>
+</ul>
+<div class="highlight-python"><div class="highlight"><pre> <span class="kn">import</span> <span class="nn">src</span>
+
+ <span class="c"># Define all possible option for mycommand command : 'sat mycommand <options>'</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">Options</span><span class="p">()</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">'m'</span><span class="p">,</span> <span class="s">'myoption'</span><span class="p">,</span> \
+ <span class="s">'boolean'</span><span class="p">,</span> <span class="s">'myoption'</span><span class="p">,</span> \
+ <span class="s">'My option changes the behavior of my command.'</span><span class="p">)</span>
+
+<span class="hll"> <span class="k">def</span> <span class="nf">description</span><span class="p">():</span>
+</span><span class="hll"> <span class="k">return</span> <span class="n">_</span><span class="p">(</span><span class="s">"The help of mycommand."</span><span class="p">)</span>
+</span>
+ <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="c"># Parse the options</span>
+ <span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+ <span class="c"># algorithm</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="howto-access-salometools-config-and-other-commands">
+<h2>HowTo access salomeTools config and other commands<a class="headerlink" href="#howto-access-salometools-config-and-other-commands" title="Permalink to this headline">¶</a></h2>
+<p>The <em>runner</em> variable is an python instance of <em>Sat</em> class.
+It gives access to <em>runner.cfg</em> which is the data model defined from all
+<em>configuration pyconf files</em> of salomeTools
+For example, <em>runner.cfg.APPLICATION.workdir</em>
+contains the root directory of the current application.</p>
+<p>The <em>runner</em> variable gives also access to other commands of salomeTools:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="c"># as CLI_ 'sat prepare ...'</span>
+<span class="n">runner</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">runner</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="howto-logger">
+<h2>HowTo logger<a class="headerlink" href="#howto-logger" title="Permalink to this headline">¶</a></h2>
+<p>The logger variable is an instance of the Logger class.
+It gives access to the write method.</p>
+<p>When this method is called, the message passed as parameter
+will be displayed in the terminal and written in an xml log file.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"My message"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c"># 3 as default</span>
+</pre></div>
+</div>
+<p>The second argument defines the level of verbosity
+that is wanted for this message.
+It has to be between 1 and 5 (the most verbose level).</p>
+</div>
+<div class="section" id="hello-example">
+<h2>HELLO example<a class="headerlink" href="#hello-example" title="Permalink to this headline">¶</a></h2>
+<p>Here is a <em>hello</em> command, file <em>commands/hello.py</em>:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">src</span>
+
+<span class="sd">"""</span>
+<span class="sd">hello.py</span>
+<span class="sd">Define all possible options for hello command:</span>
+<span class="sd">sat hello <options></span>
+<span class="sd">"""</span>
+
+<span class="n">parser</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">Options</span><span class="p">()</span>
+<span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">'f'</span><span class="p">,</span> <span class="s">'french'</span><span class="p">,</span> <span class="s">'boolean'</span><span class="p">,</span> <span class="s">'french'</span><span class="p">,</span> <span class="s">"french set hello message in french."</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">description</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">_</span><span class="p">(</span><span class="s">"The help of hello."</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="c"># Parse the options</span>
+ <span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+ <span class="c"># algorithm</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">options</span><span class="o">.</span><span class="n">french</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'HELLO! WORLD!</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'Bonjour tout le monde!</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>A first call of hello:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="c"># Get the help of hello:</span>
+./sat --help hello
+
+<span class="c"># To get bonjour</span>
+./sat hello --french
+Bonjour tout le monde!
+
+<span class="c"># To get hello</span>
+./sat hello
+HELLO! WORLD!
+
+<span class="c"># To get the log</span>
+./sat log
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Add a user custom command</a><ul>
+<li><a class="reference internal" href="#introduction">Introduction</a></li>
+<li><a class="reference internal" href="#basic-requirements">Basic requirements</a></li>
+<li><a class="reference internal" href="#howto-access-salometools-config-and-other-commands">HowTo access salomeTools config and other commands</a></li>
+<li><a class="reference internal" href="#howto-logger">HowTo logger</a></li>
+<li><a class="reference internal" href="#hello-example">HELLO example</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="commands/generate.html" title="previous chapter">Command generate</a></li>
+ <li>Next: <a href="commands/apidoc/modules.html" title="next chapter">src</a></li>
+ </ul></li>
+</ul>
+</div>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/write_command.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2018, CEA.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
+
+ |
+ <a href="_sources/write_command.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+# Makefile for Sphinx LaTeX output
+
+ALLDOCS = $(basename $(wildcard *.tex))
+ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
+ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
+
+# Prefix for archive names
+ARCHIVEPRREFIX =
+# Additional LaTeX options
+LATEXOPTS =
+
+all: $(ALLPDF)
+all-pdf: $(ALLPDF)
+all-dvi: $(ALLDVI)
+all-ps: all-dvi
+ for f in *.dvi; do dvips $$f; done
+
+all-pdf-ja:
+ for f in *.pdf *.png *.gif *.jpg *.jpeg; do ebb $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.dvi; do dvipdfmx $$f; done
+
+zip: all-$(FMT)
+ mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+ cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+ zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT)
+ rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+tar: all-$(FMT)
+ mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+ cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+ tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT)
+ rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+bz2: tar
+ bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+
+# The number of LaTeX runs is quite conservative, but I don't expect it
+# to get run often, so the little extra time won't hurt.
+%.dvi: %.tex
+ latex $(LATEXOPTS) '$<'
+ latex $(LATEXOPTS) '$<'
+ latex $(LATEXOPTS) '$<'
+ -makeindex -s python.ist '$(basename $<).idx'
+ latex $(LATEXOPTS) '$<'
+ latex $(LATEXOPTS) '$<'
+
+%.pdf: %.tex
+ pdflatex $(LATEXOPTS) '$<'
+ pdflatex $(LATEXOPTS) '$<'
+ pdflatex $(LATEXOPTS) '$<'
+ -makeindex -s python.ist '$(basename $<).idx'
+ pdflatex $(LATEXOPTS) '$<'
+ pdflatex $(LATEXOPTS) '$<'
+
+clean:
+ rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla
+
+.PHONY: all all-pdf all-dvi all-ps clean
+.PHONY: all-pdf-ja
+
--- /dev/null
+%%% Copyright Ulf A. Lindgren
+%%%
+%%% Note Premission is granted to modify this file under
+%%% the condition that it is saved using another
+%%% file and package name.
+%%%
+%%% Revision 1.1 (1997)
+%%%
+%%% Jan. 8th Modified package name base date option
+%%% Jan. 22th Modified FmN and FmTi for error in book.cls
+%%% \MakeUppercase{#}->{\MakeUppercase#}
+%%% Apr. 6th Modified Lenny option to prevent undesired
+%%% skip of line.
+%%% Nov. 8th Fixed \@chapapp for AMS
+%%%
+%%% Revision 1.2 (1998)
+%%%
+%%% Feb. 11th Fixed appendix problem related to Bjarne
+%%% Aug. 11th Fixed problem related to 11pt and 12pt
+%%% suggested by Tomas Lundberg. THANKS!
+%%%
+%%% Revision 1.3 (2004)
+%%% Sep. 20th problem with frontmatter, mainmatter and
+%%% backmatter, pointed out by Lapo Mori
+%%%
+%%% Revision 1.31 (2004)
+%%% Sep. 21th problem with the Rejne definition streched text
+%%% caused ugly gaps in the vrule aligned with the title
+%%% text. Kindly pointed out to me by Hendri Adriaens
+%%%
+%%% Revision 1.32 (2005)
+%%% Jun. 23th compatibility problem with the KOMA class 'scrbook.cls'
+%%% a remedy is a redefinition of '\@schapter' in
+%%% line with that used in KOMA. The problem was pointed
+%%% out to me by Mikkel Holm Olsen
+%%%
+%%% Revision 1.33 (2005)
+%%% Aug. 9th misspelled ``TWELV'' corrected, the error was pointed
+%%% out to me by George Pearson
+%%%
+%%% Revision 1.34 (2007)
+%%% Added an alternative to Lenny provided by Peter
+%%% Osborne (2005-11-28)
+%%% Corrected front, main and back matter, based on input
+%%% from Bas van Gils (2006-04-24)
+%%% Jul. 30th Added Bjornstrup option provided by Jean-Marc
+%%% Francois (2007-01-05).
+%%% Reverted to \MakeUppercase{#} see rev 1.1, solved
+%%% problem with MakeUppercase and MakeLowercase pointed
+%%% out by Marco Feuerstein (2007-06-06)
+
+
+%%% Last modified Jul. 2007
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesPackage{fncychap}
+ [2007/07/30 v1.34
+ LaTeX package (Revised chapters)]
+
+%%%% For conditional inclusion of color
+\newif\ifusecolor
+\usecolorfalse
+
+
+
+%%%% DEFINITION OF Chapapp variables
+\newcommand{\CNV}{\huge\bfseries}
+\newcommand{\ChNameVar}[1]{\renewcommand{\CNV}{#1}}
+
+
+%%%% DEFINITION OF TheChapter variables
+\newcommand{\CNoV}{\huge\bfseries}
+\newcommand{\ChNumVar}[1]{\renewcommand{\CNoV}{#1}}
+
+\newif\ifUCN
+\UCNfalse
+\newif\ifLCN
+\LCNfalse
+\def\ChNameLowerCase{\LCNtrue\UCNfalse}
+\def\ChNameUpperCase{\UCNtrue\LCNfalse}
+\def\ChNameAsIs{\UCNfalse\LCNfalse}
+
+%%%%% Fix for AMSBook 971008
+
+\@ifundefined{@chapapp}{\let\@chapapp\chaptername}{}
+
+
+%%%%% Fix for Bjarne and appendix 980211
+
+\newif\ifinapp
+\inappfalse
+\renewcommand\appendix{\par
+ \setcounter{chapter}{0}%
+ \setcounter{section}{0}%
+ \inapptrue%
+ \renewcommand\@chapapp{\appendixname}%
+ \renewcommand\thechapter{\@Alph\c@chapter}}
+
+%%%%% Fix for frontmatter, mainmatter, and backmatter 040920
+
+\@ifundefined{@mainmatter}{\newif\if@mainmatter \@mainmattertrue}{}
+
+%%%%%
+
+
+
+\newcommand{\FmN}[1]{%
+\ifUCN
+ {\MakeUppercase{#1}}\LCNfalse
+\else
+ \ifLCN
+ {\MakeLowercase{#1}}\UCNfalse
+ \else #1
+ \fi
+\fi}
+
+
+%%%% DEFINITION OF Title variables
+\newcommand{\CTV}{\Huge\bfseries}
+\newcommand{\ChTitleVar}[1]{\renewcommand{\CTV}{#1}}
+
+%%%% DEFINITION OF the basic rule width
+\newlength{\RW}
+\setlength{\RW}{1pt}
+\newcommand{\ChRuleWidth}[1]{\setlength{\RW}{#1}}
+
+\newif\ifUCT
+\UCTfalse
+\newif\ifLCT
+\LCTfalse
+\def\ChTitleLowerCase{\LCTtrue\UCTfalse}
+\def\ChTitleUpperCase{\UCTtrue\LCTfalse}
+\def\ChTitleAsIs{\UCTfalse\LCTfalse}
+\newcommand{\FmTi}[1]{%
+\ifUCT
+ {\MakeUppercase{#1}}\LCTfalse
+\else
+ \ifLCT
+ {\MakeLowercase{#1}}\UCTfalse
+ \else {#1}
+ \fi
+\fi}
+
+
+
+\newlength{\mylen}
+\newlength{\myhi}
+\newlength{\px}
+\newlength{\py}
+\newlength{\pyy}
+\newlength{\pxx}
+
+
+\def\mghrulefill#1{\leavevmode\leaders\hrule\@height #1\hfill\kern\z@}
+
+\newcommand{\DOCH}{%
+ \CNV\FmN{\@chapapp}\space \CNoV\thechapter
+ \par\nobreak
+ \vskip 20\p@
+ }
+\newcommand{\DOTI}[1]{%
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@
+ }
+\newcommand{\DOTIS}[1]{%
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@
+ }
+
+%%%%%% SONNY DEF
+
+\DeclareOption{Sonny}{%
+ \ChNameVar{\Large\sf}
+ \ChNumVar{\Huge}
+ \ChTitleVar{\Large\sf}
+ \ChRuleWidth{0.5pt}
+ \ChNameUpperCase
+ \renewcommand{\DOCH}{%
+ \raggedleft
+ \CNV\FmN{\@chapapp}\space \CNoV\thechapter
+ \par\nobreak
+ \vskip 40\p@}
+ \renewcommand{\DOTI}[1]{%
+ \CTV\raggedleft\mghrulefill{\RW}\par\nobreak
+ \vskip 5\p@
+ \CTV\FmTi{#1}\par\nobreak
+ \mghrulefill{\RW}\par\nobreak
+ \vskip 40\p@}
+ \renewcommand{\DOTIS}[1]{%
+ \CTV\raggedleft\mghrulefill{\RW}\par\nobreak
+ \vskip 5\p@
+ \CTV\FmTi{#1}\par\nobreak
+ \mghrulefill{\RW}\par\nobreak
+ \vskip 40\p@}
+}
+
+%%%%%% LENNY DEF
+
+\DeclareOption{Lenny}{%
+
+ \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont}
+ \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont}
+ \ChTitleVar{\Huge\bfseries\rm}
+ \ChRuleWidth{1pt}
+ \renewcommand{\DOCH}{%
+ \settowidth{\px}{\CNV\FmN{\@chapapp}}
+ \addtolength{\px}{2pt}
+ \settoheight{\py}{\CNV\FmN{\@chapapp}}
+ \addtolength{\py}{1pt}
+
+ \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter}
+ \addtolength{\mylen}{1pt}
+ \settowidth{\pxx}{\CNoV\thechapter}
+ \addtolength{\pxx}{-1pt}
+
+ \settoheight{\pyy}{\CNoV\thechapter}
+ \addtolength{\pyy}{-2pt}
+ \setlength{\myhi}{\pyy}
+ \addtolength{\myhi}{-1\py}
+ \par
+ \parbox[b]{\textwidth}{%
+ \rule[\py]{\RW}{\myhi}%
+ \hskip -\RW%
+ \rule[\pyy]{\px}{\RW}%
+ \hskip -\px%
+ \raggedright%
+ \CNV\FmN{\@chapapp}\space\CNoV\thechapter%
+ \hskip1pt%
+ \mghrulefill{\RW}%
+ \rule{\RW}{\pyy}\par\nobreak%
+ \vskip -\baselineskip%
+ \vskip -\pyy%
+ \hskip \mylen%
+ \mghrulefill{\RW}\par\nobreak%
+ \vskip \pyy}%
+ \vskip 20\p@}
+
+
+ \renewcommand{\DOTI}[1]{%
+ \raggedright
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@}
+
+ \renewcommand{\DOTIS}[1]{%
+ \raggedright
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@}
+ }
+
+%%%%%% Peter Osbornes' version of LENNY DEF
+
+\DeclareOption{PetersLenny}{%
+
+% five new lengths
+\newlength{\bl} % bottom left : orig \space
+\setlength{\bl}{6pt}
+\newcommand{\BL}[1]{\setlength{\bl}{#1}}
+\newlength{\br} % bottom right : orig 1pt
+\setlength{\br}{1pt}
+\newcommand{\BR}[1]{\setlength{\br}{#1}}
+\newlength{\tl} % top left : orig 2pt
+\setlength{\tl}{2pt}
+\newcommand{\TL}[1]{\setlength{\tl}{#1}}
+\newlength{\trr} % top right :orig 1pt
+\setlength{\trr}{1pt}
+\newcommand{\TR}[1]{\setlength{\trr}{#1}}
+\newlength{\blrule} % top right :orig 1pt
+\setlength{\trr}{0pt}
+\newcommand{\BLrule}[1]{\setlength{\blrule}{#1}}
+
+
+ \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont}
+ \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont}
+ \ChTitleVar{\Huge\bfseries\rm}
+ \ChRuleWidth{1pt}
+\renewcommand{\DOCH}{%
+
+
+%%%%%%% tweaks for 1--9 and A--Z
+\ifcase\c@chapter\relax%
+\or\BL{-3pt}\TL{-4pt}\BR{0pt}\TR{-6pt}%1
+\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%2
+\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%3
+\or\BL{0pt}\TL{5pt}\BR{2pt}\TR{-4pt}%4
+\or\BL{0pt}\TL{3pt}\BR{2pt}\TR{-4pt}%5
+\or\BL{-1pt}\TL{0pt}\BR{2pt}\TR{-2pt}%6
+\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%7
+\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%8
+\or\BL{0pt}\TL{-3pt}\BR{-4pt}\TR{-2pt}%9
+\or\BL{-3pt}\TL{-3pt}\BR{2pt}\TR{-7pt}%10
+\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%11
+\or\BL{-6pt}\TL{-6pt}\BR{2pt}\TR{-7pt}%12
+\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%13
+\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%14
+\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%15
+\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%16
+\or\BL{-5pt}\TL{-3pt}\BR{-8pt}\TR{-6pt}%17
+\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%18
+\or\BL{-3pt}\TL{-3pt}\BR{-6pt}\TR{-9pt}%19
+\or\BL{0pt}\TL{0pt}\BR{0pt}\TR{-5pt}%20
+\fi
+
+\ifinapp\ifcase\c@chapter\relax%
+\or\BL{0pt}\TL{14pt}\BR{5pt}\TR{-19pt}%A
+\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}%B
+\or\BL{-3pt}\TL{-2pt}\BR{1pt}\TR{-6pt}\BLrule{0pt}%C
+\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}\BLrule{0pt}%D
+\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-3pt}%E
+\or\BL{0pt}\TL{-5pt}\BR{-10pt}\TR{-1pt}%F
+\or\BL{-3pt}\TL{0pt}\BR{0pt}\TR{-7pt}%G
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%H
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%I
+\or\BL{2pt}\TL{0pt}\BR{-3pt}\TR{1pt}%J
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%K
+\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-19pt}%L
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%M
+\or\BL{0pt}\TL{-5pt}\BR{-2pt}\TR{-1pt}%N
+\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%O
+\or\BL{0pt}\TL{-5pt}\BR{-9pt}\TR{-3pt}%P
+\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%Q
+\or\BL{0pt}\TL{-5pt}\BR{4pt}\TR{-8pt}%R
+\or\BL{-2pt}\TL{-2pt}\BR{-2pt}\TR{-7pt}%S
+\or\BL{-3pt}\TL{0pt}\BR{-5pt}\TR{4pt}\BLrule{8pt}%T
+\or\BL{-7pt}\TL{-11pt}\BR{-5pt}\TR{-7pt}\BLrule{0pt}%U
+\or\BL{-14pt}\TL{-5pt}\BR{-14pt}\TR{-1pt}\BLrule{14pt}%V
+\or\BL{-10pt}\TL{-9pt}\BR{-13pt}\TR{-3pt}\BLrule{7pt}%W
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%X
+\or\BL{-6pt}\TL{-4pt}\BR{-7pt}\TR{1pt}\BLrule{7pt}%Y
+\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%Z
+\fi\fi
+%%%%%%%
+ \settowidth{\px}{\CNV\FmN{\@chapapp}}
+ \addtolength{\px}{\tl} %MOD change 2pt to \tl
+ \settoheight{\py}{\CNV\FmN{\@chapapp}}
+ \addtolength{\py}{1pt}
+
+ \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter}
+ \addtolength{\mylen}{\trr}% MOD change 1pt to \tr
+ \settowidth{\pxx}{\CNoV\thechapter}
+ \addtolength{\pxx}{-1pt}
+
+ \settoheight{\pyy}{\CNoV\thechapter}
+ \addtolength{\pyy}{-2pt}
+ \setlength{\myhi}{\pyy}
+ \addtolength{\myhi}{-1\py}
+ \par
+ \parbox[b]{\textwidth}{%
+ \rule[\py]{\RW}{\myhi}%
+ \hskip -\RW%
+ \rule[\pyy]{\px}{\RW}%
+ \hskip -\px%
+ \raggedright%
+ \CNV\FmN{\@chapapp}\rule{\blrule}{\RW}\hskip\bl\CNoV\thechapter%MOD
+% \CNV\FmN{\@chapapp}\space\CNoV\thechapter %ORIGINAL
+ \hskip\br% %MOD 1pt to \br
+ \mghrulefill{\RW}%
+ \rule{\RW}{\pyy}\par\nobreak%
+ \vskip -\baselineskip%
+ \vskip -\pyy%
+ \hskip \mylen%
+ \mghrulefill{\RW}\par\nobreak%
+ \vskip \pyy}%
+ \vskip 20\p@}
+
+
+ \renewcommand{\DOTI}[1]{%
+ \raggedright
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@}
+
+ \renewcommand{\DOTIS}[1]{%
+ \raggedright
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@}
+ }
+
+
+%
+
+
+%%%%%% BJORNSTRUP DEF
+
+\DeclareOption{Bjornstrup}{%
+ \usecolortrue
+ % pzc (Zapf Chancelery) is nice. ppl (Palatino) is cool too.
+ \ChNumVar{\fontsize{76}{80}\usefont{OT1}{pzc}{m}{n}\selectfont}
+ \ChTitleVar{\raggedleft\Large\sffamily\bfseries}
+
+ \setlength{\myhi}{10pt} % Space between grey box border and text
+ \setlength{\mylen}{\textwidth}
+ \addtolength{\mylen}{-2\myhi}
+ \renewcommand{\DOCH}{%
+ \settowidth{\py}{\CNoV\thechapter}
+ \addtolength{\py}{-10pt} % Amount of space by which the
+% % number is shifted right
+ \fboxsep=0pt%
+ \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}%
+ \kern-\py\raise20pt%
+ \hbox{\color[gray]{.5}\CNoV\thechapter}\\%
+ }
+
+ \renewcommand{\DOTI}[1]{%
+ \nointerlineskip\raggedright%
+ \fboxsep=\myhi%
+ \vskip-1ex%
+ \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak%
+ \vskip 40\p@%
+ }
+
+ \renewcommand{\DOTIS}[1]{%
+ \fboxsep=0pt
+ \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\%
+ \nointerlineskip\raggedright%
+ \fboxsep=\myhi%
+ \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak%
+ \vskip 40\p@%
+ }
+}
+
+
+%%%%%%% GLENN DEF
+
+
+\DeclareOption{Glenn}{%
+ \ChNameVar{\bfseries\Large\sf}
+ \ChNumVar{\Huge}
+ \ChTitleVar{\bfseries\Large\rm}
+ \ChRuleWidth{1pt}
+ \ChNameUpperCase
+ \ChTitleUpperCase
+ \renewcommand{\DOCH}{%
+ \settoheight{\myhi}{\CTV\FmTi{Test}}
+ \setlength{\py}{\baselineskip}
+ \addtolength{\py}{\RW}
+ \addtolength{\py}{\myhi}
+ \setlength{\pyy}{\py}
+ \addtolength{\pyy}{-1\RW}
+
+ \raggedright
+ \CNV\FmN{\@chapapp}\space\CNoV\thechapter
+ \hskip 3pt\mghrulefill{\RW}\rule[-1\pyy]{2\RW}{\py}\par\nobreak}
+
+ \renewcommand{\DOTI}[1]{%
+ \addtolength{\pyy}{-4pt}
+ \settoheight{\myhi}{\CTV\FmTi{#1}}
+ \addtolength{\myhi}{\py}
+ \addtolength{\myhi}{-1\RW}
+ \vskip -1\pyy
+ \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt
+ \raggedleft\CTV\FmTi{#1}\par\nobreak
+ \vskip 80\p@}
+
+\newlength{\backskip}
+ \renewcommand{\DOTIS}[1]{%
+% \setlength{\py}{10pt}
+% \setlength{\pyy}{\py}
+% \addtolength{\pyy}{\RW}
+% \setlength{\myhi}{\baselineskip}
+% \addtolength{\myhi}{\pyy}
+% \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak
+% \addtolength{}{}
+%\vskip -1\baselineskip
+% \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt
+% \raggedleft\CTV\FmTi{#1}\par\nobreak
+% \vskip 60\p@}
+%% Fix suggested by Tomas Lundberg
+ \setlength{\py}{25pt} % eller vad man vill
+ \setlength{\pyy}{\py}
+ \setlength{\backskip}{\py}
+ \addtolength{\backskip}{2pt}
+ \addtolength{\pyy}{\RW}
+ \setlength{\myhi}{\baselineskip}
+ \addtolength{\myhi}{\pyy}
+ \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak
+ \vskip -1\backskip
+ \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 3pt %
+ \raggedleft\CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@}
+ }
+
+%%%%%%% CONNY DEF
+
+\DeclareOption{Conny}{%
+ \ChNameUpperCase
+ \ChTitleUpperCase
+ \ChNameVar{\centering\Huge\rm\bfseries}
+ \ChNumVar{\Huge}
+ \ChTitleVar{\centering\Huge\rm}
+ \ChRuleWidth{2pt}
+
+ \renewcommand{\DOCH}{%
+ \mghrulefill{3\RW}\par\nobreak
+ \vskip -0.5\baselineskip
+ \mghrulefill{\RW}\par\nobreak
+ \CNV\FmN{\@chapapp}\space \CNoV\thechapter
+ \par\nobreak
+ \vskip -0.5\baselineskip
+ }
+ \renewcommand{\DOTI}[1]{%
+ \mghrulefill{\RW}\par\nobreak
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 60\p@
+ }
+ \renewcommand{\DOTIS}[1]{%
+ \mghrulefill{\RW}\par\nobreak
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 60\p@
+ }
+ }
+
+%%%%%%% REJNE DEF
+
+\DeclareOption{Rejne}{%
+
+ \ChNameUpperCase
+ \ChTitleUpperCase
+ \ChNameVar{\centering\Large\rm}
+ \ChNumVar{\Huge}
+ \ChTitleVar{\centering\Huge\rm}
+ \ChRuleWidth{1pt}
+ \renewcommand{\DOCH}{%
+ \settoheight{\py}{\CNoV\thechapter}
+ \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31
+ \addtolength{\py}{-1pt}
+ \CNV\FmN{\@chapapp}\par\nobreak
+ \vskip 20\p@
+ \setlength{\myhi}{2\baselineskip}
+ \setlength{\px}{\myhi}
+ \addtolength{\px}{-1\RW}
+ \rule[-1\px]{\RW}{\myhi}\mghrulefill{\RW}\hskip
+ 10pt\raisebox{-0.5\py}{\CNoV\thechapter}\hskip 10pt\mghrulefill{\RW}\rule[-1\px]{\RW}{\myhi}\par\nobreak
+ \vskip -3\p@% Added -2pt vskip to correct for streched text v1.31
+ }
+ \renewcommand{\DOTI}[1]{%
+ \setlength{\mylen}{\textwidth}
+ \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31
+ \addtolength{\mylen}{-2\RW}
+ {\vrule width\RW}\parbox{\mylen}{\CTV\FmTi{#1}}{\vrule width\RW}\par\nobreak%
+ \vskip -3pt\rule{\RW}{2\baselineskip}\mghrulefill{\RW}\rule{\RW}{2\baselineskip}%
+ \vskip 60\p@% Added -2pt in vskip to correct for streched text v1.31
+ }
+ \renewcommand{\DOTIS}[1]{%
+ \setlength{\py}{\fboxrule}
+ \setlength{\fboxrule}{\RW}
+ \setlength{\mylen}{\textwidth}
+ \addtolength{\mylen}{-2\RW}
+ \fbox{\parbox{\mylen}{\vskip 2\baselineskip\CTV\FmTi{#1}\par\nobreak\vskip \baselineskip}}
+ \setlength{\fboxrule}{\py}
+ \vskip 60\p@
+ }
+ }
+
+
+%%%%%%% BJARNE DEF
+
+\DeclareOption{Bjarne}{%
+ \ChNameUpperCase
+ \ChTitleUpperCase
+ \ChNameVar{\raggedleft\normalsize\rm}
+ \ChNumVar{\raggedleft \bfseries\Large}
+ \ChTitleVar{\raggedleft \Large\rm}
+ \ChRuleWidth{1pt}
+
+
+%% Note thechapter -> c@chapter fix appendix bug
+%% Fixed misspelled 12
+
+ \newcounter{AlphaCnt}
+ \newcounter{AlphaDecCnt}
+ \newcommand{\AlphaNo}{%
+ \ifcase\number\theAlphaCnt
+ \ifnum\c@chapter=0
+ ZERO\else{}\fi
+ \or ONE\or TWO\or THREE\or FOUR\or FIVE
+ \or SIX\or SEVEN\or EIGHT\or NINE\or TEN
+ \or ELEVEN\or TWELVE\or THIRTEEN\or FOURTEEN\or FIFTEEN
+ \or SIXTEEN\or SEVENTEEN\or EIGHTEEN\or NINETEEN\fi
+}
+
+ \newcommand{\AlphaDecNo}{%
+ \setcounter{AlphaDecCnt}{0}
+ \@whilenum\number\theAlphaCnt>0\do
+ {\addtocounter{AlphaCnt}{-10}
+ \addtocounter{AlphaDecCnt}{1}}
+ \ifnum\number\theAlphaCnt=0
+ \else
+ \addtocounter{AlphaDecCnt}{-1}
+ \addtocounter{AlphaCnt}{10}
+ \fi
+
+
+ \ifcase\number\theAlphaDecCnt\or TEN\or TWENTY\or THIRTY\or
+ FORTY\or FIFTY\or SIXTY\or SEVENTY\or EIGHTY\or NINETY\fi
+ }
+ \newcommand{\TheAlphaChapter}{%
+
+ \ifinapp
+ \thechapter
+ \else
+ \setcounter{AlphaCnt}{\c@chapter}
+ \ifnum\c@chapter<20
+ \AlphaNo
+ \else
+ \AlphaDecNo\AlphaNo
+ \fi
+ \fi
+ }
+ \renewcommand{\DOCH}{%
+ \mghrulefill{\RW}\par\nobreak
+ \CNV\FmN{\@chapapp}\par\nobreak
+ \CNoV\TheAlphaChapter\par\nobreak
+ \vskip -1\baselineskip\vskip 5pt\mghrulefill{\RW}\par\nobreak
+ \vskip 20\p@
+ }
+ \renewcommand{\DOTI}[1]{%
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@
+ }
+ \renewcommand{\DOTIS}[1]{%
+ \CTV\FmTi{#1}\par\nobreak
+ \vskip 40\p@
+ }
+}
+
+\DeclareOption*{%
+ \PackageWarning{fancychapter}{unknown style option}
+ }
+
+\ProcessOptions* \relax
+
+\ifusecolor
+ \RequirePackage{color}
+\fi
+\def\@makechapterhead#1{%
+ \vspace*{50\p@}%
+ {\parindent \z@ \raggedright \normalfont
+ \ifnum \c@secnumdepth >\m@ne
+ \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 040920
+ \DOCH
+ \fi
+ \fi
+ \interlinepenalty\@M
+ \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 060424
+ \DOTI{#1}%
+ \else%
+ \DOTIS{#1}%
+ \fi
+ }}
+
+
+%%% Begin: To avoid problem with scrbook.cls (fncychap version 1.32)
+
+%%OUT:
+%\def\@schapter#1{\if@twocolumn
+% \@topnewpage[\@makeschapterhead{#1}]%
+% \else
+% \@makeschapterhead{#1}%
+% \@afterheading
+% \fi}
+
+%%IN:
+\def\@schapter#1{%
+\if@twocolumn%
+ \@makeschapterhead{#1}%
+\else%
+ \@makeschapterhead{#1}%
+ \@afterheading%
+\fi}
+
+%%% End: To avoid problem with scrbook.cls (fncychap version 1.32)
+
+\def\@makeschapterhead#1{%
+ \vspace*{50\p@}%
+ {\parindent \z@ \raggedright
+ \normalfont
+ \interlinepenalty\@M
+ \DOTIS{#1}
+ \vskip 40\p@
+ }}
+
+\endinput
+
+
--- /dev/null
+line_max 100
+headings_flag 1
+heading_prefix " \\bigletter "
+
+preamble "\\begin{theindex}
+\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}}
+
+"
+
+symhead_positive "{Symbols}"
+numhead_positive "{Numbers}"
--- /dev/null
+\relax
+\providecommand\hyper@newdestlabel[2]{}
+\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
+\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
+\global\let\oldcontentsline\contentsline
+\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
+\global\let\oldnewlabel\newlabel
+\gdef\newlabel#1#2{\newlabelxx{#1}#2}
+\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
+\AtEndDocument{\ifx\hyper@anchor\@undefined
+\let\contentsline\oldcontentsline
+\let\newlabel\oldnewlabel
+\fi}
+\fi}
+\global\let\hyper@last\relax
+\gdef\HyperFirstAtBeginDocument#1{#1}
+\providecommand\HyField@AuxAddToFields[1]{}
+\providecommand\HyField@AuxAddToCoFields[2]{}
+\babel@aux{english}{}
+\newlabel{index::doc}{{}{1}{}{section*.2}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:svn}{{1}{3}{Quick start}{chapter.1}{}}
+\newlabel{index:quick-start}{{1}{3}{Quick start}{chapter.1}{}}
+\newlabel{index:salome-tools}{{1}{3}{Quick start}{chapter.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}}
+\newlabel{installation_of_sat:installation}{{1.1}{3}{Installation}{section.1.1}{}}
+\newlabel{installation_of_sat::doc}{{1.1}{3}{Installation}{section.1.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}}
+\newlabel{configuration:configuration}{{1.2}{3}{Configuration}{section.1.2}{}}
+\newlabel{configuration::doc}{{1.2}{3}{Configuration}{section.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}}
+\newlabel{configuration:syntax}{{1.2.1}{3}{Syntax}{subsection.1.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}}
+\newlabel{configuration:description}{{1.2.2}{3}{Description}{subsection.1.2.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}}
+\newlabel{configuration:vars-section}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
+\newlabel{configuration:id1}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
+\@writefile{toc}{\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}}
+\newlabel{configuration:products-section}{{1.2.2}{4}{PRODUCTS section}{subsubsection*.4}{}}
+\@writefile{toc}{\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}}
+\newlabel{configuration:application-section}{{1.2.2}{4}{APPLICATION section}{subsubsection*.5}{}}
+\@writefile{toc}{\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}}
+\newlabel{configuration:user-section}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
+\newlabel{configuration:id2}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{4}{section.1.3}}
+\newlabel{usage_of_sat:svn}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}}
+\newlabel{usage_of_sat:usage-of-salometools}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}}
+\newlabel{usage_of_sat::doc}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Usage}{4}{subsection.1.3.1}}
+\newlabel{usage_of_sat:usage}{{1.3.1}{4}{Usage}{subsection.1.3.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Options of sat}{4}{subsubsection*.7}}
+\newlabel{usage_of_sat:options-of-sat}{{1.3.1}{4}{Options of sat}{subsubsection*.7}{}}
+\@writefile{toc}{\contentsline {paragraph}{\emph {--help or -h}}{5}{paragraph*.8}}
+\newlabel{usage_of_sat:help-or-h}{{1.3.1}{5}{\emph {--help or -h}}{paragraph*.8}{}}
+\@writefile{toc}{\contentsline {paragraph}{\emph {--debug or -g}}{5}{paragraph*.9}}
+\newlabel{usage_of_sat:debug-or-g}{{1.3.1}{5}{\emph {--debug or -g}}{paragraph*.9}{}}
+\@writefile{toc}{\contentsline {paragraph}{\emph {--verbose or -v}}{5}{paragraph*.10}}
+\newlabel{usage_of_sat:verbose-or-v}{{1.3.1}{5}{\emph {--verbose or -v}}{paragraph*.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}}
+\newlabel{usage_of_sat:build-a-salome-product}{{1.3.2}{5}{Build a SALOME product}{subsection.1.3.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}}
+\newlabel{usage_of_sat:get-the-list-of-available-products}{{1.3.2}{5}{Get the list of available products}{subsubsection*.11}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}}
+\newlabel{usage_of_sat:prepare-sources-of-a-product}{{1.3.2}{5}{Prepare sources of a product}{subsubsection*.12}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Compile SALOME}{5}{subsubsection*.13}}
+\newlabel{usage_of_sat:compile-salome}{{1.3.2}{5}{Compile SALOME}{subsubsection*.13}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:list-of-commands}{{2}{7}{List of Commands}{chapter.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.1}Command config}{7}{section.2.1}}
+\newlabel{commands/config:svn}{{2.1}{7}{Command config}{section.2.1}{}}
+\newlabel{commands/config:command-config}{{2.1}{7}{Command config}{section.2.1}{}}
+\newlabel{commands/config::doc}{{2.1}{7}{Command config}{section.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description}{7}{subsection.2.1.1}}
+\newlabel{commands/config:description}{{2.1.1}{7}{Description}{subsection.2.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Usage}{7}{subsection.2.1.2}}
+\newlabel{commands/config:usage}{{2.1.2}{7}{Usage}{subsection.2.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}}
+\newlabel{commands/config:some-useful-configuration-pathes}{{2.1.3}{8}{Some useful configuration pathes}{subsection.2.1.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command prepare}{8}{section.2.2}}
+\newlabel{commands/prepare:svn}{{2.2}{8}{Command prepare}{section.2.2}{}}
+\newlabel{commands/prepare:command-prepare}{{2.2}{8}{Command prepare}{section.2.2}{}}
+\newlabel{commands/prepare::doc}{{2.2}{8}{Command prepare}{section.2.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{8}{subsection.2.2.1}}
+\newlabel{commands/prepare:description}{{2.2.1}{8}{Description}{subsection.2.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Remarks}{8}{subsection.2.2.2}}
+\newlabel{commands/prepare:remarks}{{2.2.2}{8}{Remarks}{subsection.2.2.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{8}{subsubsection*.14}}
+\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.2.2}{8}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{9}{subsubsection*.15}}
+\newlabel{commands/prepare:dev-mode}{{2.2.2}{9}{Dev mode}{subsubsection*.15}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Usage}{9}{subsection.2.2.3}}
+\newlabel{commands/prepare:usage}{{2.2.3}{9}{Usage}{subsection.2.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{9}{subsection.2.2.4}}
+\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.2.4}{9}{Some useful configuration pathes}{subsection.2.2.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command compile}{10}{section.2.3}}
+\newlabel{commands/compile:svn}{{2.3}{10}{Command compile}{section.2.3}{}}
+\newlabel{commands/compile:command-compile}{{2.3}{10}{Command compile}{section.2.3}{}}
+\newlabel{commands/compile::doc}{{2.3}{10}{Command compile}{section.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{10}{subsection.2.3.1}}
+\newlabel{commands/compile:description}{{2.3.1}{10}{Description}{subsection.2.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Usage}{10}{subsection.2.3.2}}
+\newlabel{commands/compile:usage}{{2.3.2}{10}{Usage}{subsection.2.3.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{11}{subsection.2.3.3}}
+\newlabel{commands/compile:some-useful-configuration-pathes}{{2.3.3}{11}{Some useful configuration pathes}{subsection.2.3.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command launcher}{11}{section.2.4}}
+\newlabel{commands/launcher:svn}{{2.4}{11}{Command launcher}{section.2.4}{}}
+\newlabel{commands/launcher:command-launcher}{{2.4}{11}{Command launcher}{section.2.4}{}}
+\newlabel{commands/launcher::doc}{{2.4}{11}{Command launcher}{section.2.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{11}{subsection.2.4.1}}
+\newlabel{commands/launcher:description}{{2.4.1}{11}{Description}{subsection.2.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{11}{subsection.2.4.2}}
+\newlabel{commands/launcher:usage}{{2.4.2}{11}{Usage}{subsection.2.4.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Configuration}{11}{subsection.2.4.3}}
+\newlabel{commands/launcher:configuration}{{2.4.3}{11}{Configuration}{subsection.2.4.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command application}{12}{section.2.5}}
+\newlabel{commands/application:svn}{{2.5}{12}{Command application}{section.2.5}{}}
+\newlabel{commands/application::doc}{{2.5}{12}{Command application}{section.2.5}{}}
+\newlabel{commands/application:command-application}{{2.5}{12}{Command application}{section.2.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description}{12}{subsection.2.5.1}}
+\newlabel{commands/application:description}{{2.5.1}{12}{Description}{subsection.2.5.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}Usage}{12}{subsection.2.5.2}}
+\newlabel{commands/application:usage}{{2.5.2}{12}{Usage}{subsection.2.5.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{12}{subsection.2.5.3}}
+\newlabel{commands/application:some-useful-configuration-pathes}{{2.5.3}{12}{Some useful configuration pathes}{subsection.2.5.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command log}{13}{section.2.6}}
+\newlabel{commands/log:svn}{{2.6}{13}{Command log}{section.2.6}{}}
+\newlabel{commands/log:command-log}{{2.6}{13}{Command log}{section.2.6}{}}
+\newlabel{commands/log::doc}{{2.6}{13}{Command log}{section.2.6}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.1}Description}{13}{subsection.2.6.1}}
+\newlabel{commands/log:description}{{2.6.1}{13}{Description}{subsection.2.6.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.2}Usage}{13}{subsection.2.6.2}}
+\newlabel{commands/log:usage}{{2.6.2}{13}{Usage}{subsection.2.6.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{13}{subsection.2.6.3}}
+\newlabel{commands/log:some-useful-configuration-pathes}{{2.6.3}{13}{Some useful configuration pathes}{subsection.2.6.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command environ}{13}{section.2.7}}
+\newlabel{commands/environ:svn}{{2.7}{13}{Command environ}{section.2.7}{}}
+\newlabel{commands/environ:command-environ}{{2.7}{13}{Command environ}{section.2.7}{}}
+\newlabel{commands/environ::doc}{{2.7}{13}{Command environ}{section.2.7}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.1}Description}{13}{subsection.2.7.1}}
+\newlabel{commands/environ:description}{{2.7.1}{13}{Description}{subsection.2.7.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.2}Usage}{14}{subsection.2.7.2}}
+\newlabel{commands/environ:usage}{{2.7.2}{14}{Usage}{subsection.2.7.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Configuration}{14}{subsection.2.7.3}}
+\newlabel{commands/environ:configuration}{{2.7.3}{14}{Configuration}{subsection.2.7.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command clean}{15}{section.2.8}}
+\newlabel{commands/clean:svn}{{2.8}{15}{Command clean}{section.2.8}{}}
+\newlabel{commands/clean:command-clean}{{2.8}{15}{Command clean}{section.2.8}{}}
+\newlabel{commands/clean::doc}{{2.8}{15}{Command clean}{section.2.8}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{15}{subsection.2.8.1}}
+\newlabel{commands/clean:description}{{2.8.1}{15}{Description}{subsection.2.8.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{15}{subsection.2.8.2}}
+\newlabel{commands/clean:usage}{{2.8.2}{15}{Usage}{subsection.2.8.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Availables options}{16}{subsection.2.8.3}}
+\newlabel{commands/clean:availables-options}{{2.8.3}{16}{Availables options}{subsection.2.8.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{16}{subsection.2.8.4}}
+\newlabel{commands/clean:some-useful-configuration-pathes}{{2.8.4}{16}{Some useful configuration pathes}{subsection.2.8.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command package}{16}{section.2.9}}
+\newlabel{commands/package:svn}{{2.9}{16}{Command package}{section.2.9}{}}
+\newlabel{commands/package:command-package}{{2.9}{16}{Command package}{section.2.9}{}}
+\newlabel{commands/package::doc}{{2.9}{16}{Command package}{section.2.9}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.1}Description}{16}{subsection.2.9.1}}
+\newlabel{commands/package:description}{{2.9.1}{16}{Description}{subsection.2.9.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.2}Usage}{16}{subsection.2.9.2}}
+\newlabel{commands/package:usage}{{2.9.2}{16}{Usage}{subsection.2.9.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{17}{subsection.2.9.3}}
+\newlabel{commands/package:some-useful-configuration-pathes}{{2.9.3}{17}{Some useful configuration pathes}{subsection.2.9.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command generate}{17}{section.2.10}}
+\newlabel{commands/generate:svn}{{2.10}{17}{Command generate}{section.2.10}{}}
+\newlabel{commands/generate:command-generate}{{2.10}{17}{Command generate}{section.2.10}{}}
+\newlabel{commands/generate::doc}{{2.10}{17}{Command generate}{section.2.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{17}{subsection.2.10.1}}
+\newlabel{commands/generate:description}{{2.10.1}{17}{Description}{subsection.2.10.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Remarks}{18}{subsection.2.10.2}}
+\newlabel{commands/generate:remarks}{{2.10.2}{18}{Remarks}{subsection.2.10.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Usage}{18}{subsection.2.10.3}}
+\newlabel{commands/generate:usage}{{2.10.3}{18}{Usage}{subsection.2.10.3}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{19}{chapter.3}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:developer-documentation}{{3}{19}{Developer documentation}{chapter.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {3.1}Add a user custom command}{19}{section.3.1}}
+\newlabel{write_command:svn}{{3.1}{19}{Add a user custom command}{section.3.1}{}}
+\newlabel{write_command:add-a-user-custom-command}{{3.1}{19}{Add a user custom command}{section.3.1}{}}
+\newlabel{write_command::doc}{{3.1}{19}{Add a user custom command}{section.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Introduction}{19}{subsection.3.1.1}}
+\newlabel{write_command:introduction}{{3.1.1}{19}{Introduction}{subsection.3.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{19}{subsection.3.1.2}}
+\newlabel{write_command:basic-requirements}{{3.1.2}{19}{Basic requirements}{subsection.3.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{20}{subsection.3.1.3}}
+\newlabel{write_command:howto-access-salometools-config-and-other-commands}{{3.1.3}{20}{HowTo access salomeTools config and other commands}{subsection.3.1.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{20}{subsection.3.1.4}}
+\newlabel{write_command:howto-logger}{{3.1.4}{20}{HowTo logger}{subsection.3.1.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}HELLO example}{20}{subsection.3.1.5}}
+\newlabel{write_command:hello-example}{{3.1.5}{20}{HELLO example}{subsection.3.1.5}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {4}Code documentation}{23}{chapter.4}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:code-documentation}{{4}{23}{Code documentation}{chapter.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {4.1}src}{23}{section.4.1}}
+\newlabel{commands/apidoc/modules:src}{{4.1}{23}{src}{section.4.1}{}}
+\newlabel{commands/apidoc/modules::doc}{{4.1}{23}{src}{section.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src Package}{23}{subsection.4.1.1}}
+\newlabel{commands/apidoc/src::doc}{{4.1.1}{23}{src Package}{subsection.4.1.1}{}}
+\newlabel{commands/apidoc/src:src-package}{{4.1.1}{23}{src Package}{subsection.4.1.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {src} Package}{23}{subsubsection*.16}}
+\newlabel{commands/apidoc/src:id1}{{4.1.1}{23}{\texttt {src} Package}{subsubsection*.16}{}}
+\newlabel{commands/apidoc/src:module-src.__init__}{{4.1.1}{23}{\texttt {src} Package}{section*.17}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path}{{4.1.1}{23}{\texttt {src} Package}{section*.18}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.base}{{4.1.1}{23}{\texttt {src} Package}{section*.19}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.chmod}{{4.1.1}{23}{\texttt {src} Package}{section*.20}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.copy}{{4.1.1}{23}{\texttt {src} Package}{section*.21}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.copydir}{{4.1.1}{23}{\texttt {src} Package}{section*.22}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.copyfile}{{4.1.1}{23}{\texttt {src} Package}{section*.23}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.copylink}{{4.1.1}{23}{\texttt {src} Package}{section*.24}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.dir}{{4.1.1}{23}{\texttt {src} Package}{section*.25}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.exists}{{4.1.1}{23}{\texttt {src} Package}{section*.26}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.isdir}{{4.1.1}{23}{\texttt {src} Package}{section*.27}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.isfile}{{4.1.1}{23}{\texttt {src} Package}{section*.28}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.islink}{{4.1.1}{23}{\texttt {src} Package}{section*.29}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.list}{{4.1.1}{23}{\texttt {src} Package}{section*.30}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.make}{{4.1.1}{23}{\texttt {src} Package}{section*.31}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.readlink}{{4.1.1}{23}{\texttt {src} Package}{section*.32}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.rm}{{4.1.1}{23}{\texttt {src} Package}{section*.33}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.smartcopy}{{4.1.1}{23}{\texttt {src} Package}{section*.34}{}}
+\newlabel{commands/apidoc/src:src.__init__.Path.symlink}{{4.1.1}{23}{\texttt {src} Package}{section*.35}{}}
+\newlabel{commands/apidoc/src:src.__init__.SatException}{{4.1.1}{23}{\texttt {src} Package}{section*.36}{}}
+\newlabel{commands/apidoc/src:src.__init__.activate_mesa_property}{{4.1.1}{23}{\texttt {src} Package}{section*.37}{}}
+\newlabel{commands/apidoc/src:src.__init__.check_config_has_application}{{4.1.1}{23}{\texttt {src} Package}{section*.38}{}}
+\newlabel{commands/apidoc/src:src.__init__.check_config_has_profile}{{4.1.1}{24}{\texttt {src} Package}{section*.39}{}}
+\newlabel{commands/apidoc/src:src.__init__.config_has_application}{{4.1.1}{24}{\texttt {src} Package}{section*.40}{}}
+\newlabel{commands/apidoc/src:src.__init__.deepcopy_list}{{4.1.1}{24}{\texttt {src} Package}{section*.41}{}}
+\newlabel{commands/apidoc/src:src.__init__.ensure_path_exists}{{4.1.1}{24}{\texttt {src} Package}{section*.42}{}}
+\newlabel{commands/apidoc/src:src.__init__.find_file_in_lpath}{{4.1.1}{24}{\texttt {src} Package}{section*.43}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_base_path}{{4.1.1}{24}{\texttt {src} Package}{section*.44}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_cfg_param}{{4.1.1}{24}{\texttt {src} Package}{section*.45}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_launcher_name}{{4.1.1}{24}{\texttt {src} Package}{section*.46}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_log_path}{{4.1.1}{25}{\texttt {src} Package}{section*.47}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_property_in_product_cfg}{{4.1.1}{25}{\texttt {src} Package}{section*.48}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_salome_version}{{4.1.1}{25}{\texttt {src} Package}{section*.49}{}}
+\newlabel{commands/apidoc/src:src.__init__.get_tmp_filename}{{4.1.1}{25}{\texttt {src} Package}{section*.50}{}}
+\newlabel{commands/apidoc/src:src.__init__.handleRemoveReadonly}{{4.1.1}{25}{\texttt {src} Package}{section*.51}{}}
+\newlabel{commands/apidoc/src:src.__init__.merge_dicts}{{4.1.1}{25}{\texttt {src} Package}{section*.52}{}}
+\newlabel{commands/apidoc/src:src.__init__.only_numbers}{{4.1.1}{25}{\texttt {src} Package}{section*.53}{}}
+\newlabel{commands/apidoc/src:src.__init__.parse_date}{{4.1.1}{25}{\texttt {src} Package}{section*.54}{}}
+\newlabel{commands/apidoc/src:src.__init__.print_info}{{4.1.1}{25}{\texttt {src} Package}{section*.55}{}}
+\newlabel{commands/apidoc/src:src.__init__.read_config_from_a_file}{{4.1.1}{25}{\texttt {src} Package}{section*.56}{}}
+\newlabel{commands/apidoc/src:src.__init__.remove_item_from_list}{{4.1.1}{25}{\texttt {src} Package}{section*.57}{}}
+\newlabel{commands/apidoc/src:src.__init__.replace_in_file}{{4.1.1}{25}{\texttt {src} Package}{section*.58}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {ElementTree} Module}{25}{subsubsection*.59}}
+\newlabel{commands/apidoc/src:elementtree-module}{{4.1.1}{25}{\texttt {ElementTree} Module}{subsubsection*.59}{}}
+\newlabel{commands/apidoc/src:module-src.ElementTree}{{4.1.1}{25}{\texttt {ElementTree} Module}{subsubsection*.59}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.Comment}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.60}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.dump}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.61}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.Element}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.62}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.63}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.find}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.64}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findall}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.65}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.66}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.67}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.68}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.parse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.69}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.write}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.70}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.fromstring}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.71}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iselement}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.72}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iterparse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.73}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iterparse.next}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.74}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.parse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.75}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.PI}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.76}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.77}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.QName}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.78}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.SubElement}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.79}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.tostring}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.80}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.81}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.82}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.83}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.84}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.85}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XML}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.86}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.87}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.88}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.89}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.90}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {architecture} Module}{26}{subsubsection*.91}}
+\newlabel{commands/apidoc/src:architecture-module}{{4.1.1}{26}{\texttt {architecture} Module}{subsubsection*.91}{}}
+\newlabel{commands/apidoc/src:module-src.architecture}{{4.1.1}{26}{\texttt {architecture} Module}{subsubsection*.91}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_distrib_version}{{4.1.1}{26}{\texttt {architecture} Module}{section*.92}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_distribution}{{4.1.1}{26}{\texttt {architecture} Module}{section*.93}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_nb_proc}{{4.1.1}{27}{\texttt {architecture} Module}{section*.94}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_python_version}{{4.1.1}{27}{\texttt {architecture} Module}{section*.95}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_user}{{4.1.1}{27}{\texttt {architecture} Module}{section*.96}{}}
+\newlabel{commands/apidoc/src:src.architecture.is_windows}{{4.1.1}{27}{\texttt {architecture} Module}{section*.97}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {compilation} Module}{27}{subsubsection*.98}}
+\newlabel{commands/apidoc/src:module-src.compilation}{{4.1.1}{27}{\texttt {compilation} Module}{subsubsection*.98}{}}
+\newlabel{commands/apidoc/src:compilation-module}{{4.1.1}{27}{\texttt {compilation} Module}{subsubsection*.98}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder}{{4.1.1}{27}{\texttt {compilation} Module}{section*.99}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.build_configure}{{4.1.1}{27}{\texttt {compilation} Module}{section*.100}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.check}{{4.1.1}{27}{\texttt {compilation} Module}{section*.101}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.cmake}{{4.1.1}{27}{\texttt {compilation} Module}{section*.102}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.complete_environment}{{4.1.1}{27}{\texttt {compilation} Module}{section*.103}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.configure}{{4.1.1}{27}{\texttt {compilation} Module}{section*.104}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.105}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_default_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.106}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.107}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.108}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.hack_libtool}{{4.1.1}{27}{\texttt {compilation} Module}{section*.109}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.install}{{4.1.1}{27}{\texttt {compilation} Module}{section*.110}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.log}{{4.1.1}{27}{\texttt {compilation} Module}{section*.111}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.log_command}{{4.1.1}{27}{\texttt {compilation} Module}{section*.112}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.make}{{4.1.1}{27}{\texttt {compilation} Module}{section*.113}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.prepare}{{4.1.1}{27}{\texttt {compilation} Module}{section*.114}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{27}{\texttt {compilation} Module}{section*.115}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.wmake}{{4.1.1}{28}{\texttt {compilation} Module}{section*.116}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {debug} Module}{28}{subsubsection*.117}}
+\newlabel{commands/apidoc/src:module-src.debug}{{4.1.1}{28}{\texttt {debug} Module}{subsubsection*.117}{}}
+\newlabel{commands/apidoc/src:debug-module}{{4.1.1}{28}{\texttt {debug} Module}{subsubsection*.117}{}}
+\newlabel{commands/apidoc/src:src.debug.InStream}{{4.1.1}{28}{\texttt {debug} Module}{section*.118}{}}
+\newlabel{commands/apidoc/src:src.debug.OutStream}{{4.1.1}{28}{\texttt {debug} Module}{section*.119}{}}
+\newlabel{commands/apidoc/src:src.debug.OutStream.close}{{4.1.1}{28}{\texttt {debug} Module}{section*.120}{}}
+\newlabel{commands/apidoc/src:src.debug.getLocalEnv}{{4.1.1}{28}{\texttt {debug} Module}{section*.121}{}}
+\newlabel{commands/apidoc/src:src.debug.getStrConfigDbg}{{4.1.1}{28}{\texttt {debug} Module}{section*.122}{}}
+\newlabel{commands/apidoc/src:src.debug.getStrConfigStd}{{4.1.1}{28}{\texttt {debug} Module}{section*.123}{}}
+\newlabel{commands/apidoc/src:src.debug.indent}{{4.1.1}{28}{\texttt {debug} Module}{section*.124}{}}
+\newlabel{commands/apidoc/src:src.debug.pop_debug}{{4.1.1}{28}{\texttt {debug} Module}{section*.125}{}}
+\newlabel{commands/apidoc/src:src.debug.push_debug}{{4.1.1}{28}{\texttt {debug} Module}{section*.126}{}}
+\newlabel{commands/apidoc/src:src.debug.saveConfigDbg}{{4.1.1}{28}{\texttt {debug} Module}{section*.127}{}}
+\newlabel{commands/apidoc/src:src.debug.saveConfigStd}{{4.1.1}{28}{\texttt {debug} Module}{section*.128}{}}
+\newlabel{commands/apidoc/src:src.debug.tofix}{{4.1.1}{29}{\texttt {debug} Module}{section*.129}{}}
+\newlabel{commands/apidoc/src:src.debug.write}{{4.1.1}{29}{\texttt {debug} Module}{section*.130}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {environment} Module}{29}{subsubsection*.131}}
+\newlabel{commands/apidoc/src:environment-module}{{4.1.1}{29}{\texttt {environment} Module}{subsubsection*.131}{}}
+\newlabel{commands/apidoc/src:module-src.environment}{{4.1.1}{29}{\texttt {environment} Module}{subsubsection*.131}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ}{{4.1.1}{29}{\texttt {environment} Module}{section*.132}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.append}{{4.1.1}{29}{\texttt {environment} Module}{section*.133}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.append_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.134}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.command_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.135}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.get}{{4.1.1}{29}{\texttt {environment} Module}{section*.136}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.is_defined}{{4.1.1}{29}{\texttt {environment} Module}{section*.137}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.prepend}{{4.1.1}{29}{\texttt {environment} Module}{section*.138}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.prepend_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.139}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.set}{{4.1.1}{30}{\texttt {environment} Module}{section*.140}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter}{{4.1.1}{30}{\texttt {environment} Module}{section*.141}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{30}{\texttt {environment} Module}{section*.142}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{30}{\texttt {environment} Module}{section*.143}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron}{{4.1.1}{30}{\texttt {environment} Module}{section*.144}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{30}{\texttt {environment} Module}{section*.145}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{30}{\texttt {environment} Module}{section*.146}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{30}{\texttt {environment} Module}{section*.147}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.append}{{4.1.1}{30}{\texttt {environment} Module}{section*.148}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.dump}{{4.1.1}{30}{\texttt {environment} Module}{section*.149}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.finish}{{4.1.1}{31}{\texttt {environment} Module}{section*.150}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get}{{4.1.1}{31}{\texttt {environment} Module}{section*.151}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{31}{\texttt {environment} Module}{section*.152}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{31}{\texttt {environment} Module}{section*.153}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{31}{\texttt {environment} Module}{section*.154}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{31}{\texttt {environment} Module}{section*.155}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{31}{\texttt {environment} Module}{section*.156}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{31}{\texttt {environment} Module}{section*.157}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set}{{4.1.1}{31}{\texttt {environment} Module}{section*.158}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{31}{\texttt {environment} Module}{section*.159}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.160}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.161}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{32}{\texttt {environment} Module}{section*.162}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{32}{\texttt {environment} Module}{section*.163}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{32}{\texttt {environment} Module}{section*.164}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.165}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.166}{}}
+\newlabel{commands/apidoc/src:src.environment.Shell}{{4.1.1}{32}{\texttt {environment} Module}{section*.167}{}}
+\newlabel{commands/apidoc/src:src.environment.load_environment}{{4.1.1}{32}{\texttt {environment} Module}{section*.168}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {fileEnviron} Module}{33}{subsubsection*.169}}
+\newlabel{commands/apidoc/src:fileenviron-module}{{4.1.1}{33}{\texttt {fileEnviron} Module}{subsubsection*.169}{}}
+\newlabel{commands/apidoc/src:module-src.fileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{subsubsection*.169}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.170}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.171}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.172}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.173}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.174}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.175}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.176}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.177}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.178}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.179}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.180}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.181}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.182}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.183}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.184}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.185}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.186}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.187}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.188}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.189}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.190}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.191}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.192}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.193}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.194}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.195}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.196}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.197}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.198}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.199}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.200}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.201}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.202}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.203}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.204}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.205}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.206}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.207}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.208}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.209}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.210}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.211}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.212}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.213}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.214}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.215}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.216}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.217}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.218}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.219}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.220}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.221}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.222}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.223}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.224}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.225}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.226}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.227}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.228}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.229}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.230}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.231}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.get_file_environ}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.232}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.special_path_separator}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.233}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {fork} Module}{38}{subsubsection*.234}}
+\newlabel{commands/apidoc/src:fork-module}{{4.1.1}{38}{\texttt {fork} Module}{subsubsection*.234}{}}
+\newlabel{commands/apidoc/src:module-src.fork}{{4.1.1}{38}{\texttt {fork} Module}{subsubsection*.234}{}}
+\newlabel{commands/apidoc/src:src.fork.batch}{{4.1.1}{38}{\texttt {fork} Module}{section*.235}{}}
+\newlabel{commands/apidoc/src:src.fork.batch_salome}{{4.1.1}{38}{\texttt {fork} Module}{section*.236}{}}
+\newlabel{commands/apidoc/src:src.fork.launch_command}{{4.1.1}{38}{\texttt {fork} Module}{section*.237}{}}
+\newlabel{commands/apidoc/src:src.fork.show_progress}{{4.1.1}{38}{\texttt {fork} Module}{section*.238}{}}
+\newlabel{commands/apidoc/src:src.fork.write_back}{{4.1.1}{38}{\texttt {fork} Module}{section*.239}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {logger} Module}{38}{subsubsection*.240}}
+\newlabel{commands/apidoc/src:logger-module}{{4.1.1}{38}{\texttt {logger} Module}{subsubsection*.240}{}}
+\newlabel{commands/apidoc/src:module-src.logger}{{4.1.1}{38}{\texttt {logger} Module}{subsubsection*.240}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger}{{4.1.1}{38}{\texttt {logger} Module}{section*.241}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.add_link}{{4.1.1}{38}{\texttt {logger} Module}{section*.242}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.end_write}{{4.1.1}{39}{\texttt {logger} Module}{section*.243}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.error}{{4.1.1}{39}{\texttt {logger} Module}{section*.244}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.flush}{{4.1.1}{39}{\texttt {logger} Module}{section*.245}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}{{4.1.1}{39}{\texttt {logger} Module}{section*.246}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.write}{{4.1.1}{39}{\texttt {logger} Module}{section*.247}{}}
+\newlabel{commands/apidoc/src:src.logger.date_to_datetime}{{4.1.1}{39}{\texttt {logger} Module}{section*.248}{}}
+\newlabel{commands/apidoc/src:src.logger.list_log_file}{{4.1.1}{39}{\texttt {logger} Module}{section*.249}{}}
+\newlabel{commands/apidoc/src:src.logger.show_command_log}{{4.1.1}{39}{\texttt {logger} Module}{section*.250}{}}
+\newlabel{commands/apidoc/src:src.logger.timedelta_total_seconds}{{4.1.1}{40}{\texttt {logger} Module}{section*.251}{}}
+\newlabel{commands/apidoc/src:src.logger.update_hat_xml}{{4.1.1}{40}{\texttt {logger} Module}{section*.252}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {options} Module}{40}{subsubsection*.253}}
+\newlabel{commands/apidoc/src:module-src.options}{{4.1.1}{40}{\texttt {options} Module}{subsubsection*.253}{}}
+\newlabel{commands/apidoc/src:options-module}{{4.1.1}{40}{\texttt {options} Module}{subsubsection*.253}{}}
+\newlabel{commands/apidoc/src:src.options.OptResult}{{4.1.1}{40}{\texttt {options} Module}{section*.254}{}}
+\newlabel{commands/apidoc/src:src.options.Options}{{4.1.1}{40}{\texttt {options} Module}{section*.255}{}}
+\newlabel{commands/apidoc/src:src.options.Options.add_option}{{4.1.1}{40}{\texttt {options} Module}{section*.256}{}}
+\newlabel{commands/apidoc/src:src.options.Options.parse_args}{{4.1.1}{40}{\texttt {options} Module}{section*.257}{}}
+\newlabel{commands/apidoc/src:src.options.Options.print_help}{{4.1.1}{40}{\texttt {options} Module}{section*.258}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {printcolors} Module}{41}{subsubsection*.259}}
+\newlabel{commands/apidoc/src:printcolors-module}{{4.1.1}{41}{\texttt {printcolors} Module}{subsubsection*.259}{}}
+\newlabel{commands/apidoc/src:module-src.printcolors}{{4.1.1}{41}{\texttt {printcolors} Module}{subsubsection*.259}{}}
+\newlabel{commands/apidoc/src:src.printcolors.cleancolor}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.260}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_color_map}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.261}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_color_range}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.262}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_value}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.263}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printc}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.264}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcError}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.265}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcHeader}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.266}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcHighlight}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.267}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcInfo}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.268}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcLabel}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.269}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcSuccess}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.270}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcWarning}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.271}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {product} Module}{42}{subsubsection*.272}}
+\newlabel{commands/apidoc/src:module-src.product}{{4.1.1}{42}{\texttt {product} Module}{subsubsection*.272}{}}
+\newlabel{commands/apidoc/src:product-module}{{4.1.1}{42}{\texttt {product} Module}{subsubsection*.272}{}}
+\newlabel{commands/apidoc/src:src.product.check_config_exists}{{4.1.1}{42}{\texttt {product} Module}{section*.273}{}}
+\newlabel{commands/apidoc/src:src.product.check_installation}{{4.1.1}{42}{\texttt {product} Module}{section*.274}{}}
+\newlabel{commands/apidoc/src:src.product.check_source}{{4.1.1}{43}{\texttt {product} Module}{section*.275}{}}
+\newlabel{commands/apidoc/src:src.product.get_base_install_dir}{{4.1.1}{43}{\texttt {product} Module}{section*.276}{}}
+\newlabel{commands/apidoc/src:src.product.get_install_dir}{{4.1.1}{43}{\texttt {product} Module}{section*.277}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_components}{{4.1.1}{43}{\texttt {product} Module}{section*.278}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_config}{{4.1.1}{43}{\texttt {product} Module}{section*.279}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_dependencies}{{4.1.1}{43}{\texttt {product} Module}{section*.280}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_section}{{4.1.1}{44}{\texttt {product} Module}{section*.281}{}}
+\newlabel{commands/apidoc/src:src.product.get_products_infos}{{4.1.1}{44}{\texttt {product} Module}{section*.282}{}}
+\newlabel{commands/apidoc/src:src.product.product_compiles}{{4.1.1}{44}{\texttt {product} Module}{section*.283}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_env_script}{{4.1.1}{44}{\texttt {product} Module}{section*.284}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_logo}{{4.1.1}{44}{\texttt {product} Module}{section*.285}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_patches}{{4.1.1}{44}{\texttt {product} Module}{section*.286}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_salome_gui}{{4.1.1}{44}{\texttt {product} Module}{section*.287}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_script}{{4.1.1}{45}{\texttt {product} Module}{section*.288}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_autotools}{{4.1.1}{45}{\texttt {product} Module}{section*.289}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_cmake}{{4.1.1}{45}{\texttt {product} Module}{section*.290}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_cpp}{{4.1.1}{45}{\texttt {product} Module}{section*.291}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_debug}{{4.1.1}{45}{\texttt {product} Module}{section*.292}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_dev}{{4.1.1}{45}{\texttt {product} Module}{section*.293}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_fixed}{{4.1.1}{45}{\texttt {product} Module}{section*.294}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_generated}{{4.1.1}{45}{\texttt {product} Module}{section*.295}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_mpi}{{4.1.1}{46}{\texttt {product} Module}{section*.296}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_native}{{4.1.1}{46}{\texttt {product} Module}{section*.297}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_salome}{{4.1.1}{46}{\texttt {product} Module}{section*.298}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_sample}{{4.1.1}{46}{\texttt {product} Module}{section*.299}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_smesh_plugin}{{4.1.1}{46}{\texttt {product} Module}{section*.300}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_vcs}{{4.1.1}{46}{\texttt {product} Module}{section*.301}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {pyconf} Module}{46}{subsubsection*.302}}
+\newlabel{commands/apidoc/src:pyconf-module}{{4.1.1}{46}{\texttt {pyconf} Module}{subsubsection*.302}{}}
+\newlabel{commands/apidoc/src:module-src.pyconf}{{4.1.1}{46}{\texttt {pyconf} Module}{subsubsection*.302}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.303}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.Namespace}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.304}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.addNamespace}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.305}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.getByPath}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.306}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.load}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.307}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.removeNamespace}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.308}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigError}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.309}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigFormatError}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.310}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.311}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.312}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.313}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.314}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigList}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.315}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.316}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.317}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.318}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.319}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.320}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.321}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.322}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.323}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.324}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.325}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.326}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.327}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.328}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.329}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.load}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.330}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.location}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.331}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.match}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.332}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.333}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.334}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.335}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.336}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.337}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.338}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.339}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.340}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.341}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.342}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.343}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigResolutionError}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.344}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.345}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.evaluate}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.346}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.setPath}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.347}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.writeToStream}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.348}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.writeValue}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.349}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Expression}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.350}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Expression.evaluate}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.351}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.352}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.addMapping}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.353}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.get}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.354}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.iteritems}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.355}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.356}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.keys}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.357}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.358}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.359}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.addElement}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.360}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.findConfig}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.361}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.resolve}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.362}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.363}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.364}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.365}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.append}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.366}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.367}{}}
+\newlabel{commands/apidoc/src:src.pyconf.deepCopyMapping}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.368}{}}
+\newlabel{commands/apidoc/src:src.pyconf.defaultMergeResolve}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.369}{}}
+\newlabel{commands/apidoc/src:src.pyconf.defaultStreamOpener}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.370}{}}
+\newlabel{commands/apidoc/src:src.pyconf.isWord}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.371}{}}
+\newlabel{commands/apidoc/src:src.pyconf.makePath}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.372}{}}
+\newlabel{commands/apidoc/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.373}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {system} Module}{53}{subsubsection*.374}}
+\newlabel{commands/apidoc/src:system-module}{{4.1.1}{53}{\texttt {system} Module}{subsubsection*.374}{}}
+\newlabel{commands/apidoc/src:module-src.system}{{4.1.1}{53}{\texttt {system} Module}{subsubsection*.374}{}}
+\newlabel{commands/apidoc/src:src.system.archive_extract}{{4.1.1}{53}{\texttt {system} Module}{section*.375}{}}
+\newlabel{commands/apidoc/src:src.system.cvs_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.376}{}}
+\newlabel{commands/apidoc/src:src.system.git_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.377}{}}
+\newlabel{commands/apidoc/src:src.system.show_in_editor}{{4.1.1}{54}{\texttt {system} Module}{section*.378}{}}
+\newlabel{commands/apidoc/src:src.system.svn_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.379}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {template} Module}{55}{subsubsection*.380}}
+\newlabel{commands/apidoc/src:template-module}{{4.1.1}{55}{\texttt {template} Module}{subsubsection*.380}{}}
+\newlabel{commands/apidoc/src:module-src.template}{{4.1.1}{55}{\texttt {template} Module}{subsubsection*.380}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate}{{4.1.1}{55}{\texttt {template} Module}{section*.381}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate.delimiter}{{4.1.1}{55}{\texttt {template} Module}{section*.382}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate.pattern}{{4.1.1}{55}{\texttt {template} Module}{section*.383}{}}
+\newlabel{commands/apidoc/src:src.template.substitute}{{4.1.1}{55}{\texttt {template} Module}{section*.384}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {test\_module} Module}{55}{subsubsection*.385}}
+\newlabel{commands/apidoc/src:module-src.test_module}{{4.1.1}{55}{\texttt {test\_module} Module}{subsubsection*.385}{}}
+\newlabel{commands/apidoc/src:test-module-module}{{4.1.1}{55}{\texttt {test\_module} Module}{subsubsection*.385}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.386}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.387}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.generate_script}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.388}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.get_test_timeout}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.389}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.390}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.391}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.392}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.393}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.394}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.read_results}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.395}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_all_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.396}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_grid_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.397}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_script}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.398}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_session_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.399}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.400}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.401}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.search_known_errors}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.402}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.write_test_margin}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.403}{}}
+\newlabel{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.404}{}}
+\@writefile{toc}{\contentsline {subsubsection}{\texttt {xmlManager} Module}{56}{subsubsection*.405}}
+\newlabel{commands/apidoc/src:xmlmanager-module}{{4.1.1}{56}{\texttt {xmlManager} Module}{subsubsection*.405}{}}
+\newlabel{commands/apidoc/src:module-src.xmlManager}{{4.1.1}{56}{\texttt {xmlManager} Module}{subsubsection*.405}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.406}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.407}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.408}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.409}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.410}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.411}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.412}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.413}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.414}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.add_simple_node}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.415}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.append_node_attrib}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.416}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.417}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.write_report}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.418}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{57}{subsubsection*.419}}
+\newlabel{commands/apidoc/src:subpackages}{{4.1.1}{57}{Subpackages}{subsubsection*.419}{}}
+\@writefile{toc}{\contentsline {paragraph}{colorama Package}{57}{paragraph*.420}}
+\newlabel{commands/apidoc/src.colorama:colorama-package}{{4.1.1}{57}{colorama Package}{paragraph*.420}{}}
+\newlabel{commands/apidoc/src.colorama::doc}{{4.1.1}{57}{colorama Package}{paragraph*.420}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {colorama} Package}{57}{subparagraph*.421}}
+\newlabel{commands/apidoc/src.colorama:id1}{{4.1.1}{57}{\texttt {colorama} Package}{subparagraph*.421}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama}{{4.1.1}{57}{\texttt {colorama} Package}{section*.422}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {ansi} Module}{57}{subparagraph*.423}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansi}{{4.1.1}{57}{\texttt {ansi} Module}{subparagraph*.423}{}}
+\newlabel{commands/apidoc/src.colorama:ansi-module}{{4.1.1}{57}{\texttt {ansi} Module}{subparagraph*.423}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{57}{\texttt {ansi} Module}{section*.424}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{57}{\texttt {ansi} Module}{section*.425}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{57}{\texttt {ansi} Module}{section*.426}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{57}{\texttt {ansi} Module}{section*.427}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{57}{\texttt {ansi} Module}{section*.428}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{57}{\texttt {ansi} Module}{section*.429}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{57}{\texttt {ansi} Module}{section*.430}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.431}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.432}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.433}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.434}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.435}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.436}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{58}{\texttt {ansi} Module}{section*.437}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{58}{\texttt {ansi} Module}{section*.438}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{58}{\texttt {ansi} Module}{section*.439}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.440}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{58}{\texttt {ansi} Module}{section*.441}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{58}{\texttt {ansi} Module}{section*.442}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{58}{\texttt {ansi} Module}{section*.443}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{58}{\texttt {ansi} Module}{section*.444}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.445}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{58}{\texttt {ansi} Module}{section*.446}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{58}{\texttt {ansi} Module}{section*.447}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{58}{\texttt {ansi} Module}{section*.448}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{58}{\texttt {ansi} Module}{section*.449}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{58}{\texttt {ansi} Module}{section*.450}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.451}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.452}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.453}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.454}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.455}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.456}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.457}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.458}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.459}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.460}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.461}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{58}{\texttt {ansi} Module}{section*.462}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{58}{\texttt {ansi} Module}{section*.463}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{58}{\texttt {ansi} Module}{section*.464}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.465}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{58}{\texttt {ansi} Module}{section*.466}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{58}{\texttt {ansi} Module}{section*.467}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{59}{\texttt {ansi} Module}{section*.468}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{59}{\texttt {ansi} Module}{section*.469}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{59}{\texttt {ansi} Module}{section*.470}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{59}{\texttt {ansi} Module}{section*.471}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{59}{\texttt {ansi} Module}{section*.472}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{59}{\texttt {ansi} Module}{section*.473}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{59}{\texttt {ansi} Module}{section*.474}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{59}{\texttt {ansi} Module}{section*.475}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {ansitowin32} Module}{59}{subparagraph*.476}}
+\newlabel{commands/apidoc/src.colorama:ansitowin32-module}{{4.1.1}{59}{\texttt {ansitowin32} Module}{subparagraph*.476}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{subparagraph*.476}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.477}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.478}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.479}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.480}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.481}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.482}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.483}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.484}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.485}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.486}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.487}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.488}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.489}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.490}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.491}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.492}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.493}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {initialise} Module}{60}{subparagraph*.494}}
+\newlabel{commands/apidoc/src.colorama:initialise-module}{{4.1.1}{60}{\texttt {initialise} Module}{subparagraph*.494}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.initialise}{{4.1.1}{60}{\texttt {initialise} Module}{subparagraph*.494}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{60}{\texttt {initialise} Module}{section*.495}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{60}{\texttt {initialise} Module}{section*.496}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.init}{{4.1.1}{60}{\texttt {initialise} Module}{section*.497}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{60}{\texttt {initialise} Module}{section*.498}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{60}{\texttt {initialise} Module}{section*.499}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{60}{\texttt {initialise} Module}{section*.500}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {win32} Module}{60}{subparagraph*.501}}
+\newlabel{commands/apidoc/src.colorama:win32-module}{{4.1.1}{60}{\texttt {win32} Module}{subparagraph*.501}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.win32}{{4.1.1}{60}{\texttt {win32} Module}{subparagraph*.501}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{60}{\texttt {win32} Module}{section*.502}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{60}{\texttt {win32} Module}{section*.503}{}}
+\@writefile{toc}{\contentsline {subparagraph}{\texttt {winterm} Module}{60}{subparagraph*.504}}
+\newlabel{commands/apidoc/src.colorama:winterm-module}{{4.1.1}{60}{\texttt {winterm} Module}{subparagraph*.504}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.winterm}{{4.1.1}{60}{\texttt {winterm} Module}{subparagraph*.504}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{60}{\texttt {winterm} Module}{section*.505}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{60}{\texttt {winterm} Module}{section*.506}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{60}{\texttt {winterm} Module}{section*.507}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{60}{\texttt {winterm} Module}{section*.508}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{60}{\texttt {winterm} Module}{section*.509}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{60}{\texttt {winterm} Module}{section*.510}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{60}{\texttt {winterm} Module}{section*.511}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{60}{\texttt {winterm} Module}{section*.512}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{60}{\texttt {winterm} Module}{section*.513}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{60}{\texttt {winterm} Module}{section*.514}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{60}{\texttt {winterm} Module}{section*.515}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{60}{\texttt {winterm} Module}{section*.516}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{60}{\texttt {winterm} Module}{section*.517}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{60}{\texttt {winterm} Module}{section*.518}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{60}{\texttt {winterm} Module}{section*.519}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{60}{\texttt {winterm} Module}{section*.520}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{60}{\texttt {winterm} Module}{section*.521}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{60}{\texttt {winterm} Module}{section*.522}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{60}{\texttt {winterm} Module}{section*.523}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{60}{\texttt {winterm} Module}{section*.524}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{60}{\texttt {winterm} Module}{section*.525}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{60}{\texttt {winterm} Module}{section*.526}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{60}{\texttt {winterm} Module}{section*.527}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{60}{\texttt {winterm} Module}{section*.528}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{60}{\texttt {winterm} Module}{section*.529}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{60}{\texttt {winterm} Module}{section*.530}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{60}{\texttt {winterm} Module}{section*.531}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {5}Release Notes}{63}{chapter.5}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:release-notes}{{5}{63}{Release Notes}{chapter.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {5.1}Release notes}{63}{section.5.1}}
+\newlabel{release_notes/release_notes_5.0.0:release-notes}{{5.1}{63}{Release notes}{section.5.1}{}}
+\newlabel{release_notes/release_notes_5.0.0::doc}{{5.1}{63}{Release notes}{section.5.1}{}}
+\@writefile{toc}{\contentsline {chapter}{Python Module Index}{65}{section*.532}}
+\@writefile{toc}{\contentsline {chapter}{Index}{67}{section*.533}}
--- /dev/null
+\indexentry{src.\_\_init\_\_ (module)|hyperpage}{23}
+\indexentry{Path (class in src.\_\_init\_\_)|hyperpage}{23}
+\indexentry{base() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{chmod() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{copy() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{copydir() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{copyfile() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{copylink() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{dir() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{exists() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{isdir() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{isfile() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{islink() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{list() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{make() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{readlink() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{rm() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{smartcopy() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{symlink() (src.\_\_init\_\_.Path method)|hyperpage}{23}
+\indexentry{SatException|hyperpage}{23}
+\indexentry{activate\_mesa\_property() (in module src.\_\_init\_\_)|hyperpage}{23}
+\indexentry{check\_config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{23}
+\indexentry{check\_config\_has\_profile() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{deepcopy\_list() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{ensure\_path\_exists() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{find\_file\_in\_lpath() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{get\_base\_path() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{get\_cfg\_param() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{get\_launcher\_name() (in module src.\_\_init\_\_)|hyperpage}{24}
+\indexentry{get\_log\_path() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{get\_salome\_version() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{get\_tmp\_filename() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{handleRemoveReadonly() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{merge\_dicts() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{only\_numbers() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{parse\_date() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{print\_info() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{remove\_item\_from\_list() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{replace\_in\_file() (in module src.\_\_init\_\_)|hyperpage}{25}
+\indexentry{src.ElementTree (module)|hyperpage}{25}
+\indexentry{Comment() (in module src.ElementTree)|hyperpage}{25}
+\indexentry{dump() (in module src.ElementTree)|hyperpage}{25}
+\indexentry{Element() (in module src.ElementTree)|hyperpage}{25}
+\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{25}
+\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{25}
+\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{25}
+\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{26}
+\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{26}
+\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{26}
+\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{26}
+\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{26}
+\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{iselement() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{iterparse (class in src.ElementTree)|hyperpage}{26}
+\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{26}
+\indexentry{parse() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{PI() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{QName (class in src.ElementTree)|hyperpage}{26}
+\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{tostring() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{26}
+\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{26}
+\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{26}
+\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{26}
+\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{26}
+\indexentry{XML() (in module src.ElementTree)|hyperpage}{26}
+\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{26}
+\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26}
+\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26}
+\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26}
+\indexentry{src.architecture (module)|hyperpage}{26}
+\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{26}
+\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{26}
+\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{27}
+\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{27}
+\indexentry{get\_user() (in module src.architecture)|hyperpage}{27}
+\indexentry{is\_windows() (in module src.architecture)|hyperpage}{27}
+\indexentry{src.compilation (module)|hyperpage}{27}
+\indexentry{Builder (class in src.compilation)|hyperpage}{27}
+\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{check() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{configure() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{install() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{log() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{make() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{27}
+\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{28}
+\indexentry{src.debug (module)|hyperpage}{28}
+\indexentry{InStream (class in src.debug)|hyperpage}{28}
+\indexentry{OutStream (class in src.debug)|hyperpage}{28}
+\indexentry{close() (src.debug.OutStream method)|hyperpage}{28}
+\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{28}
+\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{28}
+\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{28}
+\indexentry{indent() (in module src.debug)|hyperpage}{28}
+\indexentry{pop\_debug() (in module src.debug)|hyperpage}{28}
+\indexentry{push\_debug() (in module src.debug)|hyperpage}{28}
+\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{28}
+\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{28}
+\indexentry{tofix() (in module src.debug)|hyperpage}{29}
+\indexentry{write() (in module src.debug)|hyperpage}{29}
+\indexentry{src.environment (module)|hyperpage}{29}
+\indexentry{Environ (class in src.environment)|hyperpage}{29}
+\indexentry{append() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{get() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{prepend() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{29}
+\indexentry{set() (src.environment.Environ method)|hyperpage}{30}
+\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{30}
+\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{30}
+\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{30}
+\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{30}
+\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{30}
+\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{30}
+\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{30}
+\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{30}
+\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{30}
+\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{31}
+\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{32}
+\indexentry{Shell (class in src.environment)|hyperpage}{32}
+\indexentry{load\_environment() (in module src.environment)|hyperpage}{32}
+\indexentry{src.fileEnviron (module)|hyperpage}{33}
+\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{33}
+\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33}
+\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33}
+\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33}
+\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{33}
+\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33}
+\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33}
+\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33}
+\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33}
+\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33}
+\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{33}
+\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34}
+\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{34}
+\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{34}
+\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{35}
+\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{36}
+\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{36}
+\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{36}
+\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36}
+\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37}
+\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{37}
+\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37}
+\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38}
+\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38}
+\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38}
+\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{38}
+\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{38}
+\indexentry{src.fork (module)|hyperpage}{38}
+\indexentry{batch() (in module src.fork)|hyperpage}{38}
+\indexentry{batch\_salome() (in module src.fork)|hyperpage}{38}
+\indexentry{launch\_command() (in module src.fork)|hyperpage}{38}
+\indexentry{show\_progress() (in module src.fork)|hyperpage}{38}
+\indexentry{write\_back() (in module src.fork)|hyperpage}{38}
+\indexentry{src.logger (module)|hyperpage}{38}
+\indexentry{Logger (class in src.logger)|hyperpage}{38}
+\indexentry{add\_link() (src.logger.Logger method)|hyperpage}{38}
+\indexentry{end\_write() (src.logger.Logger method)|hyperpage}{39}
+\indexentry{error() (src.logger.Logger method)|hyperpage}{39}
+\indexentry{flush() (src.logger.Logger method)|hyperpage}{39}
+\indexentry{put\_initial\_xml\_fields() (src.logger.Logger method)|hyperpage}{39}
+\indexentry{write() (src.logger.Logger method)|hyperpage}{39}
+\indexentry{date\_to\_datetime() (in module src.logger)|hyperpage}{39}
+\indexentry{list\_log\_file() (in module src.logger)|hyperpage}{39}
+\indexentry{show\_command\_log() (in module src.logger)|hyperpage}{39}
+\indexentry{timedelta\_total\_seconds() (in module src.logger)|hyperpage}{40}
+\indexentry{update\_hat\_xml() (in module src.logger)|hyperpage}{40}
+\indexentry{src.options (module)|hyperpage}{40}
+\indexentry{OptResult (class in src.options)|hyperpage}{40}
+\indexentry{Options (class in src.options)|hyperpage}{40}
+\indexentry{add\_option() (src.options.Options method)|hyperpage}{40}
+\indexentry{parse\_args() (src.options.Options method)|hyperpage}{40}
+\indexentry{print\_help() (src.options.Options method)|hyperpage}{40}
+\indexentry{src.printcolors (module)|hyperpage}{41}
+\indexentry{cleancolor() (in module src.printcolors)|hyperpage}{41}
+\indexentry{print\_color\_map() (in module src.printcolors)|hyperpage}{41}
+\indexentry{print\_color\_range() (in module src.printcolors)|hyperpage}{41}
+\indexentry{print\_value() (in module src.printcolors)|hyperpage}{41}
+\indexentry{printc() (in module src.printcolors)|hyperpage}{41}
+\indexentry{printcError() (in module src.printcolors)|hyperpage}{41}
+\indexentry{printcHeader() (in module src.printcolors)|hyperpage}{41}
+\indexentry{printcHighlight() (in module src.printcolors)|hyperpage}{41}
+\indexentry{printcInfo() (in module src.printcolors)|hyperpage}{42}
+\indexentry{printcLabel() (in module src.printcolors)|hyperpage}{42}
+\indexentry{printcSuccess() (in module src.printcolors)|hyperpage}{42}
+\indexentry{printcWarning() (in module src.printcolors)|hyperpage}{42}
+\indexentry{src.product (module)|hyperpage}{42}
+\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{42}
+\indexentry{check\_installation() (in module src.product)|hyperpage}{42}
+\indexentry{check\_source() (in module src.product)|hyperpage}{43}
+\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{43}
+\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{43}
+\indexentry{get\_product\_components() (in module src.product)|hyperpage}{43}
+\indexentry{get\_product\_config() (in module src.product)|hyperpage}{43}
+\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{43}
+\indexentry{get\_product\_section() (in module src.product)|hyperpage}{44}
+\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{44}
+\indexentry{product\_compiles() (in module src.product)|hyperpage}{44}
+\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{44}
+\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{44}
+\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{44}
+\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{44}
+\indexentry{product\_has\_script() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{45}
+\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{46}
+\indexentry{product\_is\_native() (in module src.product)|hyperpage}{46}
+\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{46}
+\indexentry{product\_is\_sample() (in module src.product)|hyperpage}{46}
+\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{46}
+\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{46}
+\indexentry{src.pyconf (module)|hyperpage}{46}
+\indexentry{Config (class in src.pyconf)|hyperpage}{47}
+\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{47}
+\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{47}
+\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{48}
+\indexentry{load() (src.pyconf.Config method)|hyperpage}{48}
+\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{48}
+\indexentry{ConfigError|hyperpage}{48}
+\indexentry{ConfigFormatError|hyperpage}{48}
+\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{48}
+\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{48}
+\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{48}
+\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{48}
+\indexentry{ConfigList (class in src.pyconf)|hyperpage}{48}
+\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{48}
+\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{48}
+\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{48}
+\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{48}
+\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{49}
+\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{49}
+\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{49}
+\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{49}
+\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{49}
+\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{49}
+\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{49}
+\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{49}
+\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{49}
+\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{49}
+\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{49}
+\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{49}
+\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{50}
+\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{51}
+\indexentry{ConfigResolutionError|hyperpage}{51}
+\indexentry{Container (class in src.pyconf)|hyperpage}{51}
+\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{51}
+\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{51}
+\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{51}
+\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{51}
+\indexentry{Expression (class in src.pyconf)|hyperpage}{51}
+\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{51}
+\indexentry{Mapping (class in src.pyconf)|hyperpage}{51}
+\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{51}
+\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{52}
+\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{52}
+\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{52}
+\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{52}
+\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{52}
+\indexentry{Reference (class in src.pyconf)|hyperpage}{52}
+\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{52}
+\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{52}
+\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{52}
+\indexentry{Sequence (class in src.pyconf)|hyperpage}{52}
+\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{52}
+\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{52}
+\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{52}
+\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{52}
+\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{53}
+\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{53}
+\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{53}
+\indexentry{isWord() (in module src.pyconf)|hyperpage}{53}
+\indexentry{makePath() (in module src.pyconf)|hyperpage}{53}
+\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{53}
+\indexentry{src.system (module)|hyperpage}{53}
+\indexentry{archive\_extract() (in module src.system)|hyperpage}{53}
+\indexentry{cvs\_extract() (in module src.system)|hyperpage}{54}
+\indexentry{git\_extract() (in module src.system)|hyperpage}{54}
+\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{54}
+\indexentry{svn\_extract() (in module src.system)|hyperpage}{54}
+\indexentry{src.template (module)|hyperpage}{55}
+\indexentry{MyTemplate (class in src.template)|hyperpage}{55}
+\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{55}
+\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{55}
+\indexentry{substitute() (in module src.template)|hyperpage}{55}
+\indexentry{src.test\_module (module)|hyperpage}{55}
+\indexentry{Test (class in src.test\_module)|hyperpage}{55}
+\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{55}
+\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{55}
+\indexentry{src.xmlManager (module)|hyperpage}{56}
+\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{56}
+\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{56}
+\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{56}
+\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{56}
+\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{56}
+\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{56}
+\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{56}
+\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{56}
+\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{56}
+\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{56}
+\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{57}
+\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{57}
+\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{57}
+\indexentry{src.colorama (module)|hyperpage}{57}
+\indexentry{src.colorama.ansi (module)|hyperpage}{57}
+\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{57}
+\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58}
+\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{58}
+\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{58}
+\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58}
+\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58}
+\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58}
+\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58}
+\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58}
+\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{58}
+\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58}
+\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{58}
+\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59}
+\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59}
+\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59}
+\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59}
+\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{59}
+\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{59}
+\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{59}
+\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{59}
+\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{59}
+\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{59}
+\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{59}
+\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{59}
+\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59}
+\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{59}
+\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{59}
+\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{59}
+\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{59}
+\indexentry{src.colorama.initialise (module)|hyperpage}{60}
+\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{init() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{60}
+\indexentry{src.colorama.win32 (module)|hyperpage}{60}
+\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{60}
+\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{60}
+\indexentry{src.colorama.winterm (module)|hyperpage}{60}
+\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{60}
+\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{60}
+\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{60}
+\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{60}
+\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{60}
+\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{60}
+\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{60}
+\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
+\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{60}
--- /dev/null
+This is makeindex, version 2.15 [TeX Live 2017] (kpathsea + Thai support).
+Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored).
+Scanning input file salomeTools.idx....done (512 entries accepted, 0 rejected).
+Sorting entries.......done (5039 comparisons).
+Generating output file salomeTools.ind....done (584 lines written, 0 warnings).
+Output written in salomeTools.ind.
+Transcript written in salomeTools.ilg.
--- /dev/null
+\begin{theindex}
+\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+
+ \bigletter A
+ \item activate\_mesa\_property() (in module src.\_\_init\_\_), \hyperpage{23}
+ \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{30}
+ \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{33}
+ \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{34}
+ \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{30}
+ \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item add\_link() (src.logger.Logger method), \hyperpage{38}
+ \item add\_option() (src.options.Options method), \hyperpage{40}
+ \item add\_simple\_node() (in module src.xmlManager), \hyperpage{56}
+ \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{56}
+ \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{30}
+ \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item addElement() (src.pyconf.Reference method), \hyperpage{52}
+ \item addMapping() (src.pyconf.Mapping method), \hyperpage{51}
+ \item addNamespace() (src.pyconf.Config method), \hyperpage{47}
+ \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{59}
+ \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{59}
+ \item AnsiBack (class in src.colorama.ansi), \hyperpage{57}
+ \item AnsiCodes (class in src.colorama.ansi), \hyperpage{58}
+ \item AnsiCursor (class in src.colorama.ansi), \hyperpage{58}
+ \item AnsiFore (class in src.colorama.ansi), \hyperpage{58}
+ \item AnsiStyle (class in src.colorama.ansi), \hyperpage{58}
+ \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{59}
+ \item append() (src.environment.Environ method), \hyperpage{29}
+ \item append() (src.environment.SalomeEnviron method), \hyperpage{30}
+ \item append() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item append() (src.pyconf.Sequence method), \hyperpage{52}
+ \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{57}
+ \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{56}
+ \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{56}
+ \item append\_value() (src.environment.Environ method), \hyperpage{29}
+ \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item archive\_extract() (in module src.system), \hyperpage{53}
+
+ \indexspace
+ \bigletter B
+ \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{58}
+ \item back() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item base() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item BashFileEnviron (class in src.fileEnviron), \hyperpage{33}
+ \item batch() (in module src.fork), \hyperpage{38}
+ \item batch\_salome() (in module src.fork), \hyperpage{38}
+ \item BatFileEnviron (class in src.fileEnviron), \hyperpage{33}
+ \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+ \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+ \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59}
+ \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{60}
+ \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{60}
+ \item build\_configure() (src.compilation.Builder method), \hyperpage{27}
+ \item Builder (class in src.compilation), \hyperpage{27}
+
+ \indexspace
+ \bigletter C
+ \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item check() (src.compilation.Builder method), \hyperpage{27}
+ \item check\_config\_exists() (in module src.product), \hyperpage{42}
+ \item check\_config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{23}
+ \item check\_config\_has\_profile() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item check\_installation() (in module src.product), \hyperpage{42}
+ \item check\_source() (in module src.product), \hyperpage{43}
+ \item chmod() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item cleancolor() (in module src.printcolors), \hyperpage{41}
+ \item clear\_line() (in module src.colorama.ansi), \hyperpage{59}
+ \item clear\_screen() (in module src.colorama.ansi), \hyperpage{59}
+ \item close() (src.debug.OutStream method), \hyperpage{28}
+ \item close() (src.ElementTree.TreeBuilder method), \hyperpage{26}
+ \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26}
+ \item close() (src.pyconf.ConfigInputStream method), \hyperpage{48}
+ \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{49}
+ \item cmake() (src.compilation.Builder method), \hyperpage{27}
+ \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{59}
+ \item colorama\_text() (in module src.colorama.initialise), \hyperpage{60}
+ \item command\_value() (src.environment.Environ method), \hyperpage{29}
+ \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{33}
+ \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{33}
+ \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36}
+ \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item Comment() (in module src.ElementTree), \hyperpage{25}
+ \item complete\_environment() (src.compilation.Builder method), \hyperpage{27}
+ \item Config (class in src.pyconf), \hyperpage{47}
+ \item Config.Namespace (class in src.pyconf), \hyperpage{47}
+ \item config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item ConfigError, \hyperpage{48}
+ \item ConfigFormatError, \hyperpage{48}
+ \item ConfigInputStream (class in src.pyconf), \hyperpage{48}
+ \item ConfigList (class in src.pyconf), \hyperpage{48}
+ \item ConfigMerger (class in src.pyconf), \hyperpage{48}
+ \item ConfigOutputStream (class in src.pyconf), \hyperpage{49}
+ \item ConfigReader (class in src.pyconf), \hyperpage{49}
+ \item ConfigResolutionError, \hyperpage{51}
+ \item configure() (src.compilation.Builder method), \hyperpage{27}
+ \item Container (class in src.pyconf), \hyperpage{51}
+ \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{33}
+ \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item copy() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item copydir() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item copyfile() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item copylink() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item cvs\_extract() (in module src.system), \hyperpage{54}
+ \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+
+ \indexspace
+ \bigletter D
+ \item data() (src.ElementTree.TreeBuilder method), \hyperpage{26}
+ \item date\_to\_datetime() (in module src.logger), \hyperpage{39}
+ \item deepcopy\_list() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item deepCopyMapping() (in module src.pyconf), \hyperpage{53}
+ \item defaultMergeResolve() (in module src.pyconf), \hyperpage{53}
+ \item defaultStreamOpener() (in module src.pyconf), \hyperpage{53}
+ \item deinit() (in module src.colorama.initialise), \hyperpage{60}
+ \item delimiter (src.template.MyTemplate attribute), \hyperpage{55}
+ \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59}
+ \item dir() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{27}
+ \item do\_default\_build() (src.compilation.Builder method), \hyperpage{27}
+ \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{27}
+ \item do\_script\_build() (src.compilation.Builder method), \hyperpage{27}
+ \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26}
+ \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{58}
+ \item dump() (in module src.ElementTree), \hyperpage{25}
+ \item dump() (src.environment.SalomeEnviron method), \hyperpage{30}
+
+ \indexspace
+ \bigletter E
+ \item Element() (in module src.ElementTree), \hyperpage{25}
+ \item ElementTree (class in src.ElementTree), \hyperpage{25}
+ \item end() (src.ElementTree.TreeBuilder method), \hyperpage{26}
+ \item end\_write() (src.logger.Logger method), \hyperpage{39}
+ \item ensure\_path\_exists() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item Environ (class in src.environment), \hyperpage{29}
+ \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item error() (src.logger.Logger method), \hyperpage{39}
+ \item evaluate() (src.pyconf.Container method), \hyperpage{51}
+ \item evaluate() (src.pyconf.Expression method), \hyperpage{51}
+ \item exists() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item Expression (class in src.pyconf), \hyperpage{51}
+ \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+
+ \indexspace
+ \bigletter F
+ \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26}
+ \item FileEnviron (class in src.fileEnviron), \hyperpage{34}
+ \item FileEnvWriter (class in src.environment), \hyperpage{30}
+ \item find() (src.ElementTree.ElementTree method), \hyperpage{25}
+ \item find\_file\_in\_lpath() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{57}
+ \item findall() (src.ElementTree.ElementTree method), \hyperpage{25}
+ \item findConfig() (src.pyconf.Reference method), \hyperpage{52}
+ \item findtext() (src.ElementTree.ElementTree method), \hyperpage{26}
+ \item finish() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{33}
+ \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{33}
+ \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item flush() (src.logger.Logger method), \hyperpage{39}
+ \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{49}
+ \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{58}
+ \item fromstring() (in module src.ElementTree), \hyperpage{26}
+
+ \indexspace
+ \bigletter G
+ \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{55}
+ \item generate\_script() (src.test\_module.Test method), \hyperpage{55}
+ \item get() (src.environment.Environ method), \hyperpage{29}
+ \item get() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{33}
+ \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item get() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item get() (src.pyconf.Mapping method), \hyperpage{52}
+ \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{56}
+ \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item get\_base\_install\_dir() (in module src.product), \hyperpage{43}
+ \item get\_base\_path() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item get\_cfg\_param() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item get\_distrib\_version() (in module src.architecture), \hyperpage{26}
+ \item get\_distribution() (in module src.architecture), \hyperpage{26}
+ \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{38}
+ \item get\_install\_dir() (in module src.product), \hyperpage{43}
+ \item get\_launcher\_name() (in module src.\_\_init\_\_), \hyperpage{24}
+ \item get\_log\_path() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item get\_nb\_proc() (in module src.architecture), \hyperpage{27}
+ \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{56}
+ \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item get\_product\_components() (in module src.product), \hyperpage{43}
+ \item get\_product\_config() (in module src.product), \hyperpage{43}
+ \item get\_product\_dependencies() (in module src.product), \hyperpage{43}
+ \item get\_product\_section() (in module src.product), \hyperpage{44}
+ \item get\_products\_infos() (in module src.product), \hyperpage{44}
+ \item get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item get\_python\_version() (in module src.architecture), \hyperpage{27}
+ \item get\_salome\_version() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{55}
+ \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{55}
+ \item get\_tmp\_filename() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item get\_user() (in module src.architecture), \hyperpage{27}
+ \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item getByPath() (src.pyconf.Config method), \hyperpage{48}
+ \item getByPath() (src.pyconf.ConfigList method), \hyperpage{48}
+ \item getChar() (src.pyconf.ConfigReader method), \hyperpage{49}
+ \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{26}
+ \item getLocalEnv() (in module src.debug), \hyperpage{28}
+ \item getroot() (src.ElementTree.ElementTree method), \hyperpage{26}
+ \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{56}
+ \item getStrConfigDbg() (in module src.debug), \hyperpage{28}
+ \item getStrConfigStd() (in module src.debug), \hyperpage{28}
+ \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{55}
+ \item getToken() (src.pyconf.ConfigReader method), \hyperpage{49}
+ \item git\_extract() (in module src.system), \hyperpage{54}
+ \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+ \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+
+ \indexspace
+ \bigletter H
+ \item hack\_libtool() (src.compilation.Builder method), \hyperpage{27}
+ \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{48}
+ \item handleRemoveReadonly() (in module src.\_\_init\_\_), \hyperpage{25}
+
+ \indexspace
+ \bigletter I
+ \item indent() (in module src.debug), \hyperpage{28}
+ \item init() (in module src.colorama.initialise), \hyperpage{60}
+ \item install() (src.compilation.Builder method), \hyperpage{27}
+ \item InStream (class in src.debug), \hyperpage{28}
+ \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{59}
+ \item is\_defined() (src.environment.Environ method), \hyperpage{29}
+ \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{59}
+ \item is\_windows() (in module src.architecture), \hyperpage{27}
+ \item isdir() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item iselement() (in module src.ElementTree), \hyperpage{26}
+ \item isfile() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item islink() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item isWord() (in module src.pyconf), \hyperpage{53}
+ \item iteritems() (src.pyconf.Mapping method), \hyperpage{52}
+ \item iterkeys() (src.pyconf.Mapping method), \hyperpage{52}
+ \item iterparse (class in src.ElementTree), \hyperpage{26}
+
+ \indexspace
+ \bigletter K
+ \item keys() (src.pyconf.Mapping method), \hyperpage{52}
+
+ \indexspace
+ \bigletter L
+ \item launch\_command() (in module src.fork), \hyperpage{38}
+ \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{36}
+ \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{57}
+ \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item list() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item list\_log\_file() (in module src.logger), \hyperpage{39}
+ \item load() (src.pyconf.Config method), \hyperpage{48}
+ \item load() (src.pyconf.ConfigReader method), \hyperpage{49}
+ \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item load\_environment() (in module src.environment), \hyperpage{32}
+ \item location() (src.pyconf.ConfigReader method), \hyperpage{49}
+ \item log() (src.compilation.Builder method), \hyperpage{27}
+ \item log\_command() (src.compilation.Builder method), \hyperpage{27}
+ \item Logger (class in src.logger), \hyperpage{38}
+
+ \indexspace
+ \bigletter M
+ \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+ \item make() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item make() (src.compilation.Builder method), \hyperpage{27}
+ \item makePath() (in module src.pyconf), \hyperpage{53}
+ \item Mapping (class in src.pyconf), \hyperpage{51}
+ \item match() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item merge() (src.pyconf.ConfigMerger method), \hyperpage{48}
+ \item merge\_dicts() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{49}
+ \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{49}
+ \item MyTemplate (class in src.template), \hyperpage{55}
+
+ \indexspace
+ \bigletter N
+ \item next() (src.ElementTree.iterparse method), \hyperpage{26}
+ \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{52}
+ \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59}
+ \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{60}
+
+ \indexspace
+ \bigletter O
+ \item only\_numbers() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item Options (class in src.options), \hyperpage{40}
+ \item OptResult (class in src.options), \hyperpage{40}
+ \item OutStream (class in src.debug), \hyperpage{28}
+ \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{49}
+ \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{53}
+
+ \indexspace
+ \bigletter P
+ \item parse() (in module src.ElementTree), \hyperpage{26}
+ \item parse() (src.ElementTree.ElementTree method), \hyperpage{26}
+ \item parse\_args() (src.options.Options method), \hyperpage{40}
+ \item parse\_date() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{50}
+ \item Path (class in src.\_\_init\_\_), \hyperpage{23}
+ \item pattern (src.template.MyTemplate attribute), \hyperpage{55}
+ \item PI() (in module src.ElementTree), \hyperpage{26}
+ \item pop\_debug() (in module src.debug), \hyperpage{28}
+ \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{58}
+ \item prepare() (src.compilation.Builder method), \hyperpage{27}
+ \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{55}
+ \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{55}
+ \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{55}
+ \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{55}
+ \item prepend() (src.environment.Environ method), \hyperpage{29}
+ \item prepend() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{35}
+ \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{37}
+ \item prepend\_value() (src.environment.Environ method), \hyperpage{29}
+ \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{36}
+ \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item print\_color\_map() (in module src.printcolors), \hyperpage{41}
+ \item print\_color\_range() (in module src.printcolors), \hyperpage{41}
+ \item print\_help() (src.options.Options method), \hyperpage{40}
+ \item print\_info() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item print\_value() (in module src.printcolors), \hyperpage{41}
+ \item printc() (in module src.printcolors), \hyperpage{41}
+ \item printcError() (in module src.printcolors), \hyperpage{41}
+ \item printcHeader() (in module src.printcolors), \hyperpage{41}
+ \item printcHighlight() (in module src.printcolors), \hyperpage{41}
+ \item printcInfo() (in module src.printcolors), \hyperpage{42}
+ \item printcLabel() (in module src.printcolors), \hyperpage{42}
+ \item printcSuccess() (in module src.printcolors), \hyperpage{42}
+ \item printcWarning() (in module src.printcolors), \hyperpage{42}
+ \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{26}
+ \item product\_compiles() (in module src.product), \hyperpage{44}
+ \item product\_has\_env\_script() (in module src.product), \hyperpage{44}
+ \item product\_has\_logo() (in module src.product), \hyperpage{44}
+ \item product\_has\_patches() (in module src.product), \hyperpage{44}
+ \item product\_has\_salome\_gui() (in module src.product), \hyperpage{44}
+ \item product\_has\_script() (in module src.product), \hyperpage{45}
+ \item product\_is\_autotools() (in module src.product), \hyperpage{45}
+ \item product\_is\_cmake() (in module src.product), \hyperpage{45}
+ \item product\_is\_cpp() (in module src.product), \hyperpage{45}
+ \item product\_is\_debug() (in module src.product), \hyperpage{45}
+ \item product\_is\_dev() (in module src.product), \hyperpage{45}
+ \item product\_is\_fixed() (in module src.product), \hyperpage{45}
+ \item product\_is\_generated() (in module src.product), \hyperpage{45}
+ \item product\_is\_mpi() (in module src.product), \hyperpage{46}
+ \item product\_is\_native() (in module src.product), \hyperpage{46}
+ \item product\_is\_salome() (in module src.product), \hyperpage{46}
+ \item product\_is\_sample() (in module src.product), \hyperpage{46}
+ \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{46}
+ \item product\_is\_vcs() (in module src.product), \hyperpage{46}
+ \item push\_debug() (in module src.debug), \hyperpage{28}
+ \item put\_initial\_xml\_fields() (src.logger.Logger method), \hyperpage{39}
+ \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{27}
+
+ \indexspace
+ \bigletter Q
+ \item QName (class in src.ElementTree), \hyperpage{26}
+
+ \indexspace
+ \bigletter R
+ \item read() (src.pyconf.ConfigInputStream method), \hyperpage{48}
+ \item read\_config\_from\_a\_file() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item read\_results() (src.test\_module.Test method), \hyperpage{55}
+ \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{48}
+ \item readlink() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item ReadXmlFile (class in src.xmlManager), \hyperpage{56}
+ \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+ \item Reference (class in src.pyconf), \hyperpage{52}
+ \item reinit() (in module src.colorama.initialise), \hyperpage{60}
+ \item remove\_item\_from\_list() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item removeNamespace() (src.pyconf.Config method), \hyperpage{48}
+ \item replace\_in\_file() (in module src.\_\_init\_\_), \hyperpage{25}
+ \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59}
+ \item reset\_all() (in module src.colorama.initialise), \hyperpage{60}
+ \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item resolve() (src.pyconf.Reference method), \hyperpage{52}
+ \item rm() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{55}
+ \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{38}
+ \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{55}
+ \item run\_script() (src.test\_module.Test method), \hyperpage{55}
+ \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{55}
+ \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{55}
+ \item run\_tests() (src.test\_module.Test method), \hyperpage{55}
+
+ \indexspace
+ \bigletter S
+ \item SalomeEnviron (class in src.environment), \hyperpage{30}
+ \item SatException, \hyperpage{23}
+ \item saveConfigDbg() (in module src.debug), \hyperpage{28}
+ \item saveConfigStd() (in module src.debug), \hyperpage{28}
+ \item ScreenEnviron (class in src.fileEnviron), \hyperpage{37}
+ \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{55}
+ \item Sequence (class in src.pyconf), \hyperpage{52}
+ \item Sequence.SeqIter (class in src.pyconf), \hyperpage{52}
+ \item set() (src.environment.Environ method), \hyperpage{30}
+ \item set() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{33}
+ \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{33}
+ \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34}
+ \item set() (src.fileEnviron.FileEnviron method), \hyperpage{36}
+ \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37}
+ \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{38}
+ \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{31}
+ \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{32}
+ \item set\_title() (in module src.colorama.ansi), \hyperpage{59}
+ \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{60}
+ \item setPath() (src.pyconf.Container method), \hyperpage{51}
+ \item setStream() (src.pyconf.ConfigReader method), \hyperpage{51}
+ \item Shell (class in src.environment), \hyperpage{32}
+ \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item show\_command\_log() (in module src.logger), \hyperpage{39}
+ \item show\_in\_editor() (in module src.system), \hyperpage{54}
+ \item show\_progress() (in module src.fork), \hyperpage{38}
+ \item smartcopy() (src.\_\_init\_\_.Path method), \hyperpage{23}
+ \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{38}
+ \item src.\_\_init\_\_ (module), \hyperpage{23}
+ \item src.architecture (module), \hyperpage{26}
+ \item src.colorama (module), \hyperpage{57}
+ \item src.colorama.ansi (module), \hyperpage{57}
+ \item src.colorama.ansitowin32 (module), \hyperpage{59}
+ \item src.colorama.initialise (module), \hyperpage{60}
+ \item src.colorama.win32 (module), \hyperpage{60}
+ \item src.colorama.winterm (module), \hyperpage{60}
+ \item src.compilation (module), \hyperpage{27}
+ \item src.debug (module), \hyperpage{28}
+ \item src.ElementTree (module), \hyperpage{25}
+ \item src.environment (module), \hyperpage{29}
+ \item src.fileEnviron (module), \hyperpage{33}
+ \item src.fork (module), \hyperpage{38}
+ \item src.logger (module), \hyperpage{38}
+ \item src.options (module), \hyperpage{40}
+ \item src.printcolors (module), \hyperpage{41}
+ \item src.product (module), \hyperpage{42}
+ \item src.pyconf (module), \hyperpage{46}
+ \item src.system (module), \hyperpage{53}
+ \item src.template (module), \hyperpage{55}
+ \item src.test\_module (module), \hyperpage{55}
+ \item src.xmlManager (module), \hyperpage{56}
+ \item start() (src.ElementTree.TreeBuilder method), \hyperpage{26}
+ \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{59}
+ \item style() (src.colorama.winterm.WinTerm method), \hyperpage{60}
+ \item SubElement() (in module src.ElementTree), \hyperpage{26}
+ \item substitute() (in module src.template), \hyperpage{55}
+ \item svn\_extract() (in module src.system), \hyperpage{54}
+ \item symlink() (src.\_\_init\_\_.Path method), \hyperpage{23}
+
+ \indexspace
+ \bigletter T
+ \item Test (class in src.test\_module), \hyperpage{55}
+ \item timedelta\_total\_seconds() (in module src.logger), \hyperpage{40}
+ \item tofix() (in module src.debug), \hyperpage{29}
+ \item tostring() (in module src.ElementTree), \hyperpage{26}
+ \item TreeBuilder (class in src.ElementTree), \hyperpage{26}
+
+ \indexspace
+ \bigletter U
+ \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{58}
+ \item update\_hat\_xml() (in module src.logger), \hyperpage{40}
+
+ \indexspace
+ \bigletter W
+ \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item winapi\_test() (in module src.colorama.win32), \hyperpage{60}
+ \item WinColor (class in src.colorama.winterm), \hyperpage{60}
+ \item WinStyle (class in src.colorama.winterm), \hyperpage{60}
+ \item WinTerm (class in src.colorama.winterm), \hyperpage{60}
+ \item wmake() (src.compilation.Builder method), \hyperpage{28}
+ \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{60}
+ \item write() (in module src.debug), \hyperpage{29}
+ \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{59}
+ \item write() (src.ElementTree.ElementTree method), \hyperpage{26}
+ \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{38}
+ \item write() (src.logger.Logger method), \hyperpage{39}
+ \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{49}
+ \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item write\_back() (in module src.fork), \hyperpage{38}
+ \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{30}
+ \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{30}
+ \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59}
+ \item write\_report() (in module src.xmlManager), \hyperpage{57}
+ \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{55}
+ \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{56}
+ \item writeToStream() (src.pyconf.Container method), \hyperpage{51}
+ \item writeToStream() (src.pyconf.Mapping method), \hyperpage{52}
+ \item writeToStream() (src.pyconf.Sequence method), \hyperpage{52}
+ \item writeValue() (src.pyconf.Container method), \hyperpage{51}
+
+ \indexspace
+ \bigletter X
+ \item XML() (in module src.ElementTree), \hyperpage{26}
+ \item XmlLogFile (class in src.xmlManager), \hyperpage{56}
+ \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{26}
+
+ \indexspace
+ \bigletter Y
+ \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{58}
+ \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{58}
+ \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{60}
+
+\end{theindex}
--- /dev/null
+This is pdfTeX, Version 3.14159265-2.6-1.40.18 (TeX Live 2017) (preloaded format=pdflatex 2018.4.13) 24 APR 2018 13:23
+entering extended mode
+ restricted \write18 enabled.
+ %&-line parsing enabled.
+**salomeTools.tex
+(./salomeTools.tex
+LaTeX2e <2017-04-15>
+Babel <3.18> and hyphenation patterns for 84 language(s) loaded.
+(./sphinxmanual.cls
+Document Class: sphinxmanual 2009/06/02 Document class (Sphinx manual)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls
+Document Class: report 2014/09/29 v1.4h Standard LaTeX document class
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo
+File: size10.clo 2014/09/29 v1.4h Standard LaTeX file (size option)
+)
+\c@part=\count79
+\c@chapter=\count80
+\c@section=\count81
+\c@subsection=\count82
+\c@subsubsection=\count83
+\c@paragraph=\count84
+\c@subparagraph=\count85
+\c@figure=\count86
+\c@table=\count87
+\abovecaptionskip=\skip41
+\belowcaptionskip=\skip42
+\bibindent=\dimen102
+))
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.st
+y
+Package: inputenc 2015/03/17 v1.2c Input encoding file
+\inpenc@prehook=\toks14
+\inpenc@posthook=\toks15
+ (/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def
+File: utf8.def 2017/01/28 v1.1t UTF-8 support for inputenc
+Now handling font encoding OML ...
+... no UTF-8 mapping file for font encoding OML
+Now handling font encoding T1 ...
+... processing UTF-8 mapping file for font encoding T1
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu
+File: t1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc
+ defining Unicode char U+00A0 (decimal 160)
+ defining Unicode char U+00A1 (decimal 161)
+ defining Unicode char U+00A3 (decimal 163)
+ defining Unicode char U+00AB (decimal 171)
+ defining Unicode char U+00AD (decimal 173)
+ defining Unicode char U+00BB (decimal 187)
+ defining Unicode char U+00BF (decimal 191)
+ defining Unicode char U+00C0 (decimal 192)
+ defining Unicode char U+00C1 (decimal 193)
+ defining Unicode char U+00C2 (decimal 194)
+ defining Unicode char U+00C3 (decimal 195)
+ defining Unicode char U+00C4 (decimal 196)
+ defining Unicode char U+00C5 (decimal 197)
+ defining Unicode char U+00C6 (decimal 198)
+ defining Unicode char U+00C7 (decimal 199)
+ defining Unicode char U+00C8 (decimal 200)
+ defining Unicode char U+00C9 (decimal 201)
+ defining Unicode char U+00CA (decimal 202)
+ defining Unicode char U+00CB (decimal 203)
+ defining Unicode char U+00CC (decimal 204)
+ defining Unicode char U+00CD (decimal 205)
+ defining Unicode char U+00CE (decimal 206)
+ defining Unicode char U+00CF (decimal 207)
+ defining Unicode char U+00D0 (decimal 208)
+ defining Unicode char U+00D1 (decimal 209)
+ defining Unicode char U+00D2 (decimal 210)
+ defining Unicode char U+00D3 (decimal 211)
+ defining Unicode char U+00D4 (decimal 212)
+ defining Unicode char U+00D5 (decimal 213)
+ defining Unicode char U+00D6 (decimal 214)
+ defining Unicode char U+00D8 (decimal 216)
+ defining Unicode char U+00D9 (decimal 217)
+ defining Unicode char U+00DA (decimal 218)
+ defining Unicode char U+00DB (decimal 219)
+ defining Unicode char U+00DC (decimal 220)
+ defining Unicode char U+00DD (decimal 221)
+ defining Unicode char U+00DE (decimal 222)
+ defining Unicode char U+00DF (decimal 223)
+ defining Unicode char U+00E0 (decimal 224)
+ defining Unicode char U+00E1 (decimal 225)
+ defining Unicode char U+00E2 (decimal 226)
+ defining Unicode char U+00E3 (decimal 227)
+ defining Unicode char U+00E4 (decimal 228)
+ defining Unicode char U+00E5 (decimal 229)
+ defining Unicode char U+00E6 (decimal 230)
+ defining Unicode char U+00E7 (decimal 231)
+ defining Unicode char U+00E8 (decimal 232)
+ defining Unicode char U+00E9 (decimal 233)
+ defining Unicode char U+00EA (decimal 234)
+ defining Unicode char U+00EB (decimal 235)
+ defining Unicode char U+00EC (decimal 236)
+ defining Unicode char U+00ED (decimal 237)
+ defining Unicode char U+00EE (decimal 238)
+ defining Unicode char U+00EF (decimal 239)
+ defining Unicode char U+00F0 (decimal 240)
+ defining Unicode char U+00F1 (decimal 241)
+ defining Unicode char U+00F2 (decimal 242)
+ defining Unicode char U+00F3 (decimal 243)
+ defining Unicode char U+00F4 (decimal 244)
+ defining Unicode char U+00F5 (decimal 245)
+ defining Unicode char U+00F6 (decimal 246)
+ defining Unicode char U+00F8 (decimal 248)
+ defining Unicode char U+00F9 (decimal 249)
+ defining Unicode char U+00FA (decimal 250)
+ defining Unicode char U+00FB (decimal 251)
+ defining Unicode char U+00FC (decimal 252)
+ defining Unicode char U+00FD (decimal 253)
+ defining Unicode char U+00FE (decimal 254)
+ defining Unicode char U+00FF (decimal 255)
+ defining Unicode char U+0100 (decimal 256)
+ defining Unicode char U+0101 (decimal 257)
+ defining Unicode char U+0102 (decimal 258)
+ defining Unicode char U+0103 (decimal 259)
+ defining Unicode char U+0104 (decimal 260)
+ defining Unicode char U+0105 (decimal 261)
+ defining Unicode char U+0106 (decimal 262)
+ defining Unicode char U+0107 (decimal 263)
+ defining Unicode char U+0108 (decimal 264)
+ defining Unicode char U+0109 (decimal 265)
+ defining Unicode char U+010A (decimal 266)
+ defining Unicode char U+010B (decimal 267)
+ defining Unicode char U+010C (decimal 268)
+ defining Unicode char U+010D (decimal 269)
+ defining Unicode char U+010E (decimal 270)
+ defining Unicode char U+010F (decimal 271)
+ defining Unicode char U+0110 (decimal 272)
+ defining Unicode char U+0111 (decimal 273)
+ defining Unicode char U+0112 (decimal 274)
+ defining Unicode char U+0113 (decimal 275)
+ defining Unicode char U+0114 (decimal 276)
+ defining Unicode char U+0115 (decimal 277)
+ defining Unicode char U+0116 (decimal 278)
+ defining Unicode char U+0117 (decimal 279)
+ defining Unicode char U+0118 (decimal 280)
+ defining Unicode char U+0119 (decimal 281)
+ defining Unicode char U+011A (decimal 282)
+ defining Unicode char U+011B (decimal 283)
+ defining Unicode char U+011C (decimal 284)
+ defining Unicode char U+011D (decimal 285)
+ defining Unicode char U+011E (decimal 286)
+ defining Unicode char U+011F (decimal 287)
+ defining Unicode char U+0120 (decimal 288)
+ defining Unicode char U+0121 (decimal 289)
+ defining Unicode char U+0122 (decimal 290)
+ defining Unicode char U+0123 (decimal 291)
+ defining Unicode char U+0124 (decimal 292)
+ defining Unicode char U+0125 (decimal 293)
+ defining Unicode char U+0128 (decimal 296)
+ defining Unicode char U+0129 (decimal 297)
+ defining Unicode char U+012A (decimal 298)
+ defining Unicode char U+012B (decimal 299)
+ defining Unicode char U+012C (decimal 300)
+ defining Unicode char U+012D (decimal 301)
+ defining Unicode char U+012E (decimal 302)
+ defining Unicode char U+012F (decimal 303)
+ defining Unicode char U+0130 (decimal 304)
+ defining Unicode char U+0131 (decimal 305)
+ defining Unicode char U+0132 (decimal 306)
+ defining Unicode char U+0133 (decimal 307)
+ defining Unicode char U+0134 (decimal 308)
+ defining Unicode char U+0135 (decimal 309)
+ defining Unicode char U+0136 (decimal 310)
+ defining Unicode char U+0137 (decimal 311)
+ defining Unicode char U+0139 (decimal 313)
+ defining Unicode char U+013A (decimal 314)
+ defining Unicode char U+013B (decimal 315)
+ defining Unicode char U+013C (decimal 316)
+ defining Unicode char U+013D (decimal 317)
+ defining Unicode char U+013E (decimal 318)
+ defining Unicode char U+0141 (decimal 321)
+ defining Unicode char U+0142 (decimal 322)
+ defining Unicode char U+0143 (decimal 323)
+ defining Unicode char U+0144 (decimal 324)
+ defining Unicode char U+0145 (decimal 325)
+ defining Unicode char U+0146 (decimal 326)
+ defining Unicode char U+0147 (decimal 327)
+ defining Unicode char U+0148 (decimal 328)
+ defining Unicode char U+014A (decimal 330)
+ defining Unicode char U+014B (decimal 331)
+ defining Unicode char U+014C (decimal 332)
+ defining Unicode char U+014D (decimal 333)
+ defining Unicode char U+014E (decimal 334)
+ defining Unicode char U+014F (decimal 335)
+ defining Unicode char U+0150 (decimal 336)
+ defining Unicode char U+0151 (decimal 337)
+ defining Unicode char U+0152 (decimal 338)
+ defining Unicode char U+0153 (decimal 339)
+ defining Unicode char U+0154 (decimal 340)
+ defining Unicode char U+0155 (decimal 341)
+ defining Unicode char U+0156 (decimal 342)
+ defining Unicode char U+0157 (decimal 343)
+ defining Unicode char U+0158 (decimal 344)
+ defining Unicode char U+0159 (decimal 345)
+ defining Unicode char U+015A (decimal 346)
+ defining Unicode char U+015B (decimal 347)
+ defining Unicode char U+015C (decimal 348)
+ defining Unicode char U+015D (decimal 349)
+ defining Unicode char U+015E (decimal 350)
+ defining Unicode char U+015F (decimal 351)
+ defining Unicode char U+0160 (decimal 352)
+ defining Unicode char U+0161 (decimal 353)
+ defining Unicode char U+0162 (decimal 354)
+ defining Unicode char U+0163 (decimal 355)
+ defining Unicode char U+0164 (decimal 356)
+ defining Unicode char U+0165 (decimal 357)
+ defining Unicode char U+0168 (decimal 360)
+ defining Unicode char U+0169 (decimal 361)
+ defining Unicode char U+016A (decimal 362)
+ defining Unicode char U+016B (decimal 363)
+ defining Unicode char U+016C (decimal 364)
+ defining Unicode char U+016D (decimal 365)
+ defining Unicode char U+016E (decimal 366)
+ defining Unicode char U+016F (decimal 367)
+ defining Unicode char U+0170 (decimal 368)
+ defining Unicode char U+0171 (decimal 369)
+ defining Unicode char U+0172 (decimal 370)
+ defining Unicode char U+0173 (decimal 371)
+ defining Unicode char U+0174 (decimal 372)
+ defining Unicode char U+0175 (decimal 373)
+ defining Unicode char U+0176 (decimal 374)
+ defining Unicode char U+0177 (decimal 375)
+ defining Unicode char U+0178 (decimal 376)
+ defining Unicode char U+0179 (decimal 377)
+ defining Unicode char U+017A (decimal 378)
+ defining Unicode char U+017B (decimal 379)
+ defining Unicode char U+017C (decimal 380)
+ defining Unicode char U+017D (decimal 381)
+ defining Unicode char U+017E (decimal 382)
+ defining Unicode char U+01CD (decimal 461)
+ defining Unicode char U+01CE (decimal 462)
+ defining Unicode char U+01CF (decimal 463)
+ defining Unicode char U+01D0 (decimal 464)
+ defining Unicode char U+01D1 (decimal 465)
+ defining Unicode char U+01D2 (decimal 466)
+ defining Unicode char U+01D3 (decimal 467)
+ defining Unicode char U+01D4 (decimal 468)
+ defining Unicode char U+01E2 (decimal 482)
+ defining Unicode char U+01E3 (decimal 483)
+ defining Unicode char U+01E6 (decimal 486)
+ defining Unicode char U+01E7 (decimal 487)
+ defining Unicode char U+01E8 (decimal 488)
+ defining Unicode char U+01E9 (decimal 489)
+ defining Unicode char U+01EA (decimal 490)
+ defining Unicode char U+01EB (decimal 491)
+ defining Unicode char U+01F0 (decimal 496)
+ defining Unicode char U+01F4 (decimal 500)
+ defining Unicode char U+01F5 (decimal 501)
+ defining Unicode char U+0218 (decimal 536)
+ defining Unicode char U+0219 (decimal 537)
+ defining Unicode char U+021A (decimal 538)
+ defining Unicode char U+021B (decimal 539)
+ defining Unicode char U+0232 (decimal 562)
+ defining Unicode char U+0233 (decimal 563)
+ defining Unicode char U+1E02 (decimal 7682)
+ defining Unicode char U+1E03 (decimal 7683)
+ defining Unicode char U+200C (decimal 8204)
+ defining Unicode char U+2010 (decimal 8208)
+ defining Unicode char U+2011 (decimal 8209)
+ defining Unicode char U+2012 (decimal 8210)
+ defining Unicode char U+2013 (decimal 8211)
+ defining Unicode char U+2014 (decimal 8212)
+ defining Unicode char U+2015 (decimal 8213)
+ defining Unicode char U+2018 (decimal 8216)
+ defining Unicode char U+2019 (decimal 8217)
+ defining Unicode char U+201A (decimal 8218)
+ defining Unicode char U+201C (decimal 8220)
+ defining Unicode char U+201D (decimal 8221)
+ defining Unicode char U+201E (decimal 8222)
+ defining Unicode char U+2030 (decimal 8240)
+ defining Unicode char U+2031 (decimal 8241)
+ defining Unicode char U+2039 (decimal 8249)
+ defining Unicode char U+203A (decimal 8250)
+ defining Unicode char U+2423 (decimal 9251)
+ defining Unicode char U+1E20 (decimal 7712)
+ defining Unicode char U+1E21 (decimal 7713)
+)
+Now handling font encoding OT1 ...
+... processing UTF-8 mapping file for font encoding OT1
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu
+File: ot1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc
+ defining Unicode char U+00A0 (decimal 160)
+ defining Unicode char U+00A1 (decimal 161)
+ defining Unicode char U+00A3 (decimal 163)
+ defining Unicode char U+00AD (decimal 173)
+ defining Unicode char U+00B8 (decimal 184)
+ defining Unicode char U+00BF (decimal 191)
+ defining Unicode char U+00C5 (decimal 197)
+ defining Unicode char U+00C6 (decimal 198)
+ defining Unicode char U+00D8 (decimal 216)
+ defining Unicode char U+00DF (decimal 223)
+ defining Unicode char U+00E6 (decimal 230)
+ defining Unicode char U+00EC (decimal 236)
+ defining Unicode char U+00ED (decimal 237)
+ defining Unicode char U+00EE (decimal 238)
+ defining Unicode char U+00EF (decimal 239)
+ defining Unicode char U+00F8 (decimal 248)
+ defining Unicode char U+0131 (decimal 305)
+ defining Unicode char U+0141 (decimal 321)
+ defining Unicode char U+0142 (decimal 322)
+ defining Unicode char U+0152 (decimal 338)
+ defining Unicode char U+0153 (decimal 339)
+ defining Unicode char U+0174 (decimal 372)
+ defining Unicode char U+0175 (decimal 373)
+ defining Unicode char U+0176 (decimal 374)
+ defining Unicode char U+0177 (decimal 375)
+ defining Unicode char U+0218 (decimal 536)
+ defining Unicode char U+0219 (decimal 537)
+ defining Unicode char U+021A (decimal 538)
+ defining Unicode char U+021B (decimal 539)
+ defining Unicode char U+2013 (decimal 8211)
+ defining Unicode char U+2014 (decimal 8212)
+ defining Unicode char U+2018 (decimal 8216)
+ defining Unicode char U+2019 (decimal 8217)
+ defining Unicode char U+201C (decimal 8220)
+ defining Unicode char U+201D (decimal 8221)
+)
+Now handling font encoding OMS ...
+... processing UTF-8 mapping file for font encoding OMS
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu
+File: omsenc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc
+ defining Unicode char U+00A7 (decimal 167)
+ defining Unicode char U+00B6 (decimal 182)
+ defining Unicode char U+00B7 (decimal 183)
+ defining Unicode char U+2020 (decimal 8224)
+ defining Unicode char U+2021 (decimal 8225)
+ defining Unicode char U+2022 (decimal 8226)
+)
+Now handling font encoding OMX ...
+... no UTF-8 mapping file for font encoding OMX
+Now handling font encoding U ...
+... no UTF-8 mapping file for font encoding U
+ defining Unicode char U+00A9 (decimal 169)
+ defining Unicode char U+00AA (decimal 170)
+ defining Unicode char U+00AE (decimal 174)
+ defining Unicode char U+00BA (decimal 186)
+ defining Unicode char U+02C6 (decimal 710)
+ defining Unicode char U+02DC (decimal 732)
+ defining Unicode char U+200C (decimal 8204)
+ defining Unicode char U+2026 (decimal 8230)
+ defining Unicode char U+2122 (decimal 8482)
+ defining Unicode char U+2423 (decimal 9251)
+))
+ defining Unicode char U+00A0 (decimal 160)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty
+Package: fontenc 2017/04/05 v2.0i Standard LaTeX package
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def
+File: t1enc.def 2017/04/05 v2.0i Standard LaTeX file
+LaTeX Font Info: Redeclaring font encoding T1 on input line 48.
+))
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.st
+y
+Package: babel 2018/02/14 3.18 The Babel package
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.d
+ef
+File: switch.def 2018/02/14 3.18 Babel switching mechanism
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/
+english.ldf
+Language: english 2017/06/06 v3.3r English support from the babel system
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.de
+f
+File: babel.def 2018/02/14 3.18 Babel common definitions
+\babel@savecnt=\count88
+\U@D=\dimen103
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel
+.def)
+\bbl@dirlevel=\count89
+)
+\l@canadian = a dialect from \language\l@american
+\l@australian = a dialect from \language\l@british
+\l@newzealand = a dialect from \language\l@british
+))
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
+Package: times 2005/04/12 PSNFSS-v9.2a (SPQR)
+) (./fncychap.sty
+Package: fncychap 2007/07/30 v1.34 LaTeX package (Revised chapters)
+\RW=\skip43
+\mylen=\skip44
+\myhi=\skip45
+\px=\skip46
+\py=\skip47
+\pyy=\skip48
+\pxx=\skip49
+\c@AlphaCnt=\count90
+\c@AlphaDecCnt=\count91
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.
+sty
+Package: longtable 2014/10/28 v4.11 Multi-page Table package (DPC)
+\LTleft=\skip50
+\LTright=\skip51
+\LTpre=\skip52
+\LTpost=\skip53
+\LTchunksize=\count92
+\LTcapwidth=\dimen104
+\LT@head=\box26
+\LT@firsthead=\box27
+\LT@foot=\box28
+\LT@lastfoot=\box29
+\LT@cols=\count93
+\LT@rows=\count94
+\c@LT@tables=\count95
+\c@LT@chunks=\count96
+\LT@p@ftn=\toks16
+) (./sphinx.sty
+Package: sphinx 2010/01/15 LaTeX package (Sphinx markup)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.st
+y
+Package: textcomp 2017/04/05 v2.0i Standard LaTeX package
+Package textcomp Info: Sub-encoding information:
+(textcomp) 5 = only ISO-Adobe without \textcurrency
+(textcomp) 4 = 5 + \texteuro
+(textcomp) 3 = 4 + \textohm
+(textcomp) 2 = 3 + \textestimated + \textcurrency
+(textcomp) 1 = TS1 - \textcircled - \t
+(textcomp) 0 = TS1 (full)
+(textcomp) Font families with sub-encoding setting implement
+(textcomp) only a restricted character set as indicated.
+(textcomp) Family '?' is the default used for unknown fonts.
+(textcomp) See the documentation for details.
+Package textcomp Info: Setting ? sub-encoding to TS1/1 on input line 79.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def
+File: ts1enc.def 2001/06/05 v3.0e (jk/car/fm) Standard LaTeX file
+Now handling font encoding TS1 ...
+... processing UTF-8 mapping file for font encoding TS1
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu
+File: ts1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc
+ defining Unicode char U+00A2 (decimal 162)
+ defining Unicode char U+00A3 (decimal 163)
+ defining Unicode char U+00A4 (decimal 164)
+ defining Unicode char U+00A5 (decimal 165)
+ defining Unicode char U+00A6 (decimal 166)
+ defining Unicode char U+00A7 (decimal 167)
+ defining Unicode char U+00A8 (decimal 168)
+ defining Unicode char U+00A9 (decimal 169)
+ defining Unicode char U+00AA (decimal 170)
+ defining Unicode char U+00AC (decimal 172)
+ defining Unicode char U+00AE (decimal 174)
+ defining Unicode char U+00AF (decimal 175)
+ defining Unicode char U+00B0 (decimal 176)
+ defining Unicode char U+00B1 (decimal 177)
+ defining Unicode char U+00B2 (decimal 178)
+ defining Unicode char U+00B3 (decimal 179)
+ defining Unicode char U+00B4 (decimal 180)
+ defining Unicode char U+00B5 (decimal 181)
+ defining Unicode char U+00B6 (decimal 182)
+ defining Unicode char U+00B7 (decimal 183)
+ defining Unicode char U+00B9 (decimal 185)
+ defining Unicode char U+00BA (decimal 186)
+ defining Unicode char U+00BC (decimal 188)
+ defining Unicode char U+00BD (decimal 189)
+ defining Unicode char U+00BE (decimal 190)
+ defining Unicode char U+00D7 (decimal 215)
+ defining Unicode char U+00F7 (decimal 247)
+ defining Unicode char U+0192 (decimal 402)
+ defining Unicode char U+02C7 (decimal 711)
+ defining Unicode char U+02D8 (decimal 728)
+ defining Unicode char U+02DD (decimal 733)
+ defining Unicode char U+0E3F (decimal 3647)
+ defining Unicode char U+2016 (decimal 8214)
+ defining Unicode char U+2020 (decimal 8224)
+ defining Unicode char U+2021 (decimal 8225)
+ defining Unicode char U+2022 (decimal 8226)
+ defining Unicode char U+2030 (decimal 8240)
+ defining Unicode char U+2031 (decimal 8241)
+ defining Unicode char U+203B (decimal 8251)
+ defining Unicode char U+203D (decimal 8253)
+ defining Unicode char U+2044 (decimal 8260)
+ defining Unicode char U+204E (decimal 8270)
+ defining Unicode char U+2052 (decimal 8274)
+ defining Unicode char U+20A1 (decimal 8353)
+ defining Unicode char U+20A4 (decimal 8356)
+ defining Unicode char U+20A6 (decimal 8358)
+ defining Unicode char U+20A9 (decimal 8361)
+ defining Unicode char U+20AB (decimal 8363)
+ defining Unicode char U+20AC (decimal 8364)
+ defining Unicode char U+20B1 (decimal 8369)
+ defining Unicode char U+2103 (decimal 8451)
+ defining Unicode char U+2116 (decimal 8470)
+ defining Unicode char U+2117 (decimal 8471)
+ defining Unicode char U+211E (decimal 8478)
+ defining Unicode char U+2120 (decimal 8480)
+ defining Unicode char U+2122 (decimal 8482)
+ defining Unicode char U+2126 (decimal 8486)
+ defining Unicode char U+2127 (decimal 8487)
+ defining Unicode char U+212E (decimal 8494)
+ defining Unicode char U+2190 (decimal 8592)
+ defining Unicode char U+2191 (decimal 8593)
+ defining Unicode char U+2192 (decimal 8594)
+ defining Unicode char U+2193 (decimal 8595)
+ defining Unicode char U+2329 (decimal 9001)
+ defining Unicode char U+232A (decimal 9002)
+ defining Unicode char U+2422 (decimal 9250)
+ defining Unicode char U+25E6 (decimal 9702)
+ defining Unicode char U+25EF (decimal 9711)
+ defining Unicode char U+266A (decimal 9834)
+))
+LaTeX Info: Redefining \oldstylenums on input line 334.
+Package textcomp Info: Setting cmr sub-encoding to TS1/0 on input line 349.
+Package textcomp Info: Setting cmss sub-encoding to TS1/0 on input line 350.
+Package textcomp Info: Setting cmtt sub-encoding to TS1/0 on input line 351.
+Package textcomp Info: Setting cmvtt sub-encoding to TS1/0 on input line 352.
+Package textcomp Info: Setting cmbr sub-encoding to TS1/0 on input line 353.
+Package textcomp Info: Setting cmtl sub-encoding to TS1/0 on input line 354.
+Package textcomp Info: Setting ccr sub-encoding to TS1/0 on input line 355.
+Package textcomp Info: Setting ptm sub-encoding to TS1/4 on input line 356.
+Package textcomp Info: Setting pcr sub-encoding to TS1/4 on input line 357.
+Package textcomp Info: Setting phv sub-encoding to TS1/4 on input line 358.
+Package textcomp Info: Setting ppl sub-encoding to TS1/3 on input line 359.
+Package textcomp Info: Setting pag sub-encoding to TS1/4 on input line 360.
+Package textcomp Info: Setting pbk sub-encoding to TS1/4 on input line 361.
+Package textcomp Info: Setting pnc sub-encoding to TS1/4 on input line 362.
+Package textcomp Info: Setting pzc sub-encoding to TS1/4 on input line 363.
+Package textcomp Info: Setting bch sub-encoding to TS1/4 on input line 364.
+Package textcomp Info: Setting put sub-encoding to TS1/5 on input line 365.
+Package textcomp Info: Setting uag sub-encoding to TS1/5 on input line 366.
+Package textcomp Info: Setting ugq sub-encoding to TS1/5 on input line 367.
+Package textcomp Info: Setting ul8 sub-encoding to TS1/4 on input line 368.
+Package textcomp Info: Setting ul9 sub-encoding to TS1/4 on input line 369.
+Package textcomp Info: Setting augie sub-encoding to TS1/5 on input line 370.
+Package textcomp Info: Setting dayrom sub-encoding to TS1/3 on input line 371.
+Package textcomp Info: Setting dayroms sub-encoding to TS1/3 on input line 372.
+
+Package textcomp Info: Setting pxr sub-encoding to TS1/0 on input line 373.
+Package textcomp Info: Setting pxss sub-encoding to TS1/0 on input line 374.
+Package textcomp Info: Setting pxtt sub-encoding to TS1/0 on input line 375.
+Package textcomp Info: Setting txr sub-encoding to TS1/0 on input line 376.
+Package textcomp Info: Setting txss sub-encoding to TS1/0 on input line 377.
+Package textcomp Info: Setting txtt sub-encoding to TS1/0 on input line 378.
+Package textcomp Info: Setting lmr sub-encoding to TS1/0 on input line 379.
+Package textcomp Info: Setting lmdh sub-encoding to TS1/0 on input line 380.
+Package textcomp Info: Setting lmss sub-encoding to TS1/0 on input line 381.
+Package textcomp Info: Setting lmssq sub-encoding to TS1/0 on input line 382.
+Package textcomp Info: Setting lmvtt sub-encoding to TS1/0 on input line 383.
+Package textcomp Info: Setting lmtt sub-encoding to TS1/0 on input line 384.
+Package textcomp Info: Setting qhv sub-encoding to TS1/0 on input line 385.
+Package textcomp Info: Setting qag sub-encoding to TS1/0 on input line 386.
+Package textcomp Info: Setting qbk sub-encoding to TS1/0 on input line 387.
+Package textcomp Info: Setting qcr sub-encoding to TS1/0 on input line 388.
+Package textcomp Info: Setting qcs sub-encoding to TS1/0 on input line 389.
+Package textcomp Info: Setting qpl sub-encoding to TS1/0 on input line 390.
+Package textcomp Info: Setting qtm sub-encoding to TS1/0 on input line 391.
+Package textcomp Info: Setting qzc sub-encoding to TS1/0 on input line 392.
+Package textcomp Info: Setting qhvc sub-encoding to TS1/0 on input line 393.
+Package textcomp Info: Setting futs sub-encoding to TS1/4 on input line 394.
+Package textcomp Info: Setting futx sub-encoding to TS1/4 on input line 395.
+Package textcomp Info: Setting futj sub-encoding to TS1/4 on input line 396.
+Package textcomp Info: Setting hlh sub-encoding to TS1/3 on input line 397.
+Package textcomp Info: Setting hls sub-encoding to TS1/3 on input line 398.
+Package textcomp Info: Setting hlst sub-encoding to TS1/3 on input line 399.
+Package textcomp Info: Setting hlct sub-encoding to TS1/5 on input line 400.
+Package textcomp Info: Setting hlx sub-encoding to TS1/5 on input line 401.
+Package textcomp Info: Setting hlce sub-encoding to TS1/5 on input line 402.
+Package textcomp Info: Setting hlcn sub-encoding to TS1/5 on input line 403.
+Package textcomp Info: Setting hlcw sub-encoding to TS1/5 on input line 404.
+Package textcomp Info: Setting hlcf sub-encoding to TS1/5 on input line 405.
+Package textcomp Info: Setting pplx sub-encoding to TS1/3 on input line 406.
+Package textcomp Info: Setting pplj sub-encoding to TS1/3 on input line 407.
+Package textcomp Info: Setting ptmx sub-encoding to TS1/4 on input line 408.
+Package textcomp Info: Setting ptmj sub-encoding to TS1/4 on input line 409.
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhd
+r.sty
+Package: fancyhdr 2017/06/30 v3.9a Extensive control of page headers and footer
+s
+\f@nch@headwidth=\skip54
+\f@nch@O@elh=\skip55
+\f@nch@O@erh=\skip56
+\f@nch@O@olh=\skip57
+\f@nch@O@orh=\skip58
+\f@nch@O@elf=\skip59
+\f@nch@O@erf=\skip60
+\f@nch@O@olf=\skip61
+\f@nch@O@orf=\skip62
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancybox/fancybo
+x.sty
+Package: fancybox 2010/05/15 1.4
+
+Style option: `fancybox' v1.4 <2010/05/15> (tvz)
+\@fancybox=\box30
+\shadowsize=\dimen105
+\@Sbox=\box31
+\do@VerbBox=\toks17
+\the@fancyput=\toks18
+\this@fancyput=\toks19
+\EndVerbatimTokens=\toks20
+\Verbatim@Outfile=\write3
+\Verbatim@Infile=\read1
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlese
+c.sty
+Package: titlesec 2016/03/21 v2.10.2 Sectioning titles
+\ttl@box=\box32
+\beforetitleunit=\skip63
+\aftertitleunit=\skip64
+\ttl@plus=\dimen106
+\ttl@minus=\dimen107
+\ttl@toksa=\toks21
+\titlewidth=\dimen108
+\titlewidthlast=\dimen109
+\titlewidthfirst=\dimen110
+) (./tabulary.sty
+Package: tabulary 2007/10/02 v0.9 tabulary package (DPC)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty
+Package: array 2016/10/06 v2.4d Tabular extension package (FMi)
+\col@sep=\dimen111
+\extrarowheight=\dimen112
+\NC@list=\toks22
+\extratabsurround=\skip65
+\backup@length=\skip66
+)
+\TY@count=\count97
+\TY@linewidth=\dimen113
+\tymin=\dimen114
+\tymax=\dimen115
+\TY@tablewidth=\dimen116
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.
+sty
+Package: amsmath 2017/09/02 v2.17a AMS math features
+\@mathmargin=\skip67
+
+For additional information on amsmath, use the `?' option.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.
+sty
+Package: amstext 2000/06/29 v2.01 AMS text
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.s
+ty
+File: amsgen.sty 1999/11/30 v2.0 generic functions
+\@emptytoks=\toks23
+\ex@=\dimen117
+))
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.s
+ty
+Package: amsbsy 1999/11/29 v1.2d Bold Symbols
+\pmbraise@=\dimen118
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.s
+ty
+Package: amsopn 2016/03/08 v2.02 operator names
+)
+\inf@bad=\count98
+LaTeX Info: Redefining \frac on input line 213.
+\uproot@=\count99
+\leftroot@=\count100
+LaTeX Info: Redefining \overline on input line 375.
+\classnum@=\count101
+\DOTSCASE@=\count102
+LaTeX Info: Redefining \ldots on input line 472.
+LaTeX Info: Redefining \dots on input line 475.
+LaTeX Info: Redefining \cdots on input line 596.
+\Mathstrutbox@=\box33
+\strutbox@=\box34
+\big@size=\dimen119
+LaTeX Font Info: Redeclaring font encoding OML on input line 712.
+LaTeX Font Info: Redeclaring font encoding OMS on input line 713.
+\macc@depth=\count103
+\c@MaxMatrixCols=\count104
+\dotsspace@=\muskip10
+\c@parentequation=\count105
+\dspbrk@lvl=\count106
+\tag@help=\toks24
+\row@=\count107
+\column@=\count108
+\maxfields@=\count109
+\andhelp@=\toks25
+\eqnshift@=\dimen120
+\alignsep@=\dimen121
+\tagshift@=\dimen122
+\tagwidth@=\dimen123
+\totwidth@=\dimen124
+\lineht@=\dimen125
+\@envbody=\toks26
+\multlinegap=\skip68
+\multlinetaggap=\skip69
+\mathdisplay@stack=\toks27
+LaTeX Info: Redefining \[ on input line 2817.
+LaTeX Info: Redefining \] on input line 2818.
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty
+Package: makeidx 2014/09/29 v1.0m Standard LaTeX package
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.st
+y
+Package: framed 2011/10/22 v 0.96: framed or shaded text with page breaks
+\OuterFrameSep=\skip70
+\fb@frw=\dimen126
+\fb@frh=\dimen127
+\FrameRule=\dimen128
+\FrameSep=\dimen129
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ifthen.sty
+Package: ifthen 2014/09/29 v1.1c Standard LaTeX ifthen package (DPC)
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/color.s
+ty
+Package: color 2016/07/10 v1.1e Standard LaTeX Color (DPC)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/col
+or.cfg
+File: color.cfg 2016/01/02 v1.6 sample color configuration
+)
+Package color Info: Driver file: pdftex.def on input line 147.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdf
+tex.def
+File: pdftex.def 2018/01/08 v1.0l Graphics/color driver for pdftex
+))
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvr
+b.sty
+Package: fancyvrb 2008/02/07
+
+Style option: `fancyvrb' v2.7a, with DG/SPQR fixes, and firstline=lastline fix
+<2008/02/07> (tvz)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.
+sty
+Package: keyval 2014/10/28 v1.15 key=value parser (DPC)
+\KV@toks@=\toks28
+)
+\FV@CodeLineNo=\count110
+\FV@InFile=\read2
+\FV@TabBox=\box35
+\c@FancyVerbLine=\count111
+\FV@StepNumber=\count112
+\FV@OutFile=\write4
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/threeparttable/t
+hreeparttable.sty
+Package: threeparttable 2003/06/13 v 3.0
+\@tempboxb=\box36
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mdwtools/footnot
+e.sty
+Package: footnote 1997/01/28 1.13 Save footnotes around boxes
+\fn@notes=\box37
+\fn@width=\dimen130
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.
+sty
+\wrapoverhang=\dimen131
+\WF@size=\dimen132
+\c@WF@wrappedlines=\count113
+\WF@box=\box38
+\WF@everypar=\toks29
+Package: wrapfig 2003/01/31 v 3.6
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.
+sty
+Package: parskip 2001/04/09 non-zero parskip adjustments
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphic
+x.sty
+Package: graphicx 2017/06/01 v1.1a Enhanced LaTeX Graphics (DPC,SPQR)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphic
+s.sty
+Package: graphics 2017/06/25 v1.2c Standard LaTeX Graphics (DPC,SPQR)
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.st
+y
+Package: trig 2016/01/03 v1.10 sin cos tan (DPC)
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/gra
+phics.cfg
+File: graphics.cfg 2016/06/04 v1.11 sample graphics configuration
+)
+Package graphics Info: Driver file: pdftex.def on input line 99.
+)
+\Gin@req@height=\dimen133
+\Gin@req@width=\dimen134
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/pdftex/pdfcolo
+r.tex)
+\distancetoright=\skip71
+\py@argswidth=\skip72
+\py@noticelength=\skip73
+\lineblockindentation=\skip74
+\image@box=\box39
+\image@width=\dimen135
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperre
+f.sty
+Package: hyperref 2018/02/06 v6.86b Hypertext links for LaTeX
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsu
+b-hyperref.sty
+Package: hobsub-hyperref 2016/05/16 v1.14 Bundle oberdiek, subset hyperref (HO)
+
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsu
+b-generic.sty
+Package: hobsub-generic 2016/05/16 v1.14 Bundle oberdiek, subset generic (HO)
+Package: hobsub 2016/05/16 v1.14 Construct package bundles (HO)
+Package: infwarerr 2016/05/16 v1.4 Providing info/warning/error messages (HO)
+Package: ltxcmds 2016/05/16 v1.23 LaTeX kernel commands for general use (HO)
+Package: ifluatex 2016/05/16 v1.4 Provides the ifluatex switch (HO)
+Package ifluatex Info: LuaTeX not detected.
+Package: ifvtex 2016/05/16 v1.6 Detect VTeX and its facilities (HO)
+Package ifvtex Info: VTeX not detected.
+Package: intcalc 2016/05/16 v1.2 Expandable calculations with integers (HO)
+Package: ifpdf 2017/03/15 v3.2 Provides the ifpdf switch
+Package: etexcmds 2016/05/16 v1.6 Avoid name clashes with e-TeX commands (HO)
+Package etexcmds Info: Could not find \expanded.
+(etexcmds) That can mean that you are not using pdfTeX 1.50 or
+(etexcmds) that some package has redefined \expanded.
+(etexcmds) In the latter case, load this package earlier.
+Package: kvsetkeys 2016/05/16 v1.17 Key value parser (HO)
+Package: kvdefinekeys 2016/05/16 v1.4 Define keys (HO)
+Package: pdftexcmds 2018/01/21 v0.26 Utility functions of pdfTeX for LuaTeX (HO
+)
+Package pdftexcmds Info: LuaTeX not detected.
+Package pdftexcmds Info: \pdf@primitive is available.
+Package pdftexcmds Info: \pdf@ifprimitive is available.
+Package pdftexcmds Info: \pdfdraftmode found.
+Package: pdfescape 2016/05/16 v1.14 Implements pdfTeX's escape features (HO)
+Package: bigintcalc 2016/05/16 v1.4 Expandable calculations on big integers (HO
+)
+Package: bitset 2016/05/16 v1.2 Handle bit-vector datatype (HO)
+Package: uniquecounter 2016/05/16 v1.3 Provide unlimited unique counter (HO)
+)
+Package hobsub Info: Skipping package `hobsub' (already loaded).
+Package: letltxmacro 2016/05/16 v1.5 Let assignment for LaTeX macros (HO)
+Package: hopatch 2016/05/16 v1.3 Wrapper for package hooks (HO)
+Package: xcolor-patch 2016/05/16 xcolor patch
+Package: atveryend 2016/05/16 v1.9 Hooks at the very end of document (HO)
+Package atveryend Info: \enddocument detected (standard20110627).
+Package: atbegshi 2016/06/09 v1.18 At begin shipout hook (HO)
+Package: refcount 2016/05/16 v3.5 Data extraction from label references (HO)
+Package: hycolor 2016/05/16 v1.8 Color options for hyperref/bookmark (HO)
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxete
+x.sty
+Package: ifxetex 2010/09/12 v0.6 Provides ifxetex conditional
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook
+.sty
+Package: auxhook 2016/05/16 v1.4 Hooks for auxiliary files (HO)
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptio
+ns.sty
+Package: kvoptions 2016/05/16 v3.12 Key value format for package options (HO)
+)
+\@linkdim=\dimen136
+\Hy@linkcounter=\count114
+\Hy@pagecounter=\count115
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.
+def
+File: pd1enc.def 2018/02/06 v6.86b Hyperref: PDFDocEncoding definition (HO)
+Now handling font encoding PD1 ...
+... no UTF-8 mapping file for font encoding PD1
+)
+\Hy@SavedSpaceFactor=\count116
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hype
+rref.cfg
+File: hyperref.cfg 2002/06/06 v1.2 hyperref configuration of TeXLive
+)
+Package hyperref Info: Option `colorlinks' set `true' on input line 4383.
+Package hyperref Info: Option `breaklinks' set `true' on input line 4383.
+Package hyperref Info: Hyper figures OFF on input line 4509.
+Package hyperref Info: Link nesting OFF on input line 4514.
+Package hyperref Info: Hyper index ON on input line 4517.
+Package hyperref Info: Plain pages OFF on input line 4524.
+Package hyperref Info: Backreferencing OFF on input line 4529.
+Package hyperref Info: Implicit mode ON; LaTeX internals redefined.
+Package hyperref Info: Bookmarks ON on input line 4762.
+\c@Hy@tempcnt=\count117
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty
+\Urlmuskip=\muskip11
+Package: url 2013/09/16 ver 3.4 Verb mode for urls, etc.
+)
+LaTeX Info: Redefining \url on input line 5115.
+\XeTeXLinkMargin=\dimen137
+\Fld@menulength=\count118
+\Field@Width=\dimen138
+\Fld@charsize=\dimen139
+Package hyperref Info: Hyper figures OFF on input line 6369.
+Package hyperref Info: Link nesting OFF on input line 6374.
+Package hyperref Info: Hyper index ON on input line 6377.
+Package hyperref Info: backreferencing OFF on input line 6384.
+Package hyperref Info: Link coloring ON on input line 6387.
+Package hyperref Info: Link coloring with OCG OFF on input line 6394.
+Package hyperref Info: PDF/A mode OFF on input line 6399.
+LaTeX Info: Redefining \ref on input line 6439.
+LaTeX Info: Redefining \pageref on input line 6443.
+\Hy@abspage=\count119
+\c@Item=\count120
+\c@Hfootnote=\count121
+)
+Package hyperref Info: Driver (autodetected): hpdftex.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex
+.def
+File: hpdftex.def 2018/02/06 v6.86b Hyperref driver for pdfTeX
+\Fld@listcount=\count122
+\c@bookmark@seq@number=\count123
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfi
+lecheck.sty
+Package: rerunfilecheck 2016/05/16 v1.8 Rerun checks for auxiliary files (HO)
+Package uniquecounter Info: New unique counter `rerunfilecheck' on input line 2
+82.
+)
+\Hy@SectionHShift=\skip75
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.
+sty
+Package: hypcap 2016/05/16 v1.12 Adjusting the anchors of captions (HO)
+)
+\DUlineblockindent=\skip76
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/multirow/multiro
+w.sty
+Package: multirow 2016/11/25 v2.2 Span multiple rows of a table
+\multirow@colwidth=\skip77
+\multirow@cntb=\count124
+\multirow@dima=\skip78
+\bigstrutjot=\dimen140
+)
+\@indexfile=\write5
+\openout5 = `salomeTools.idx'.
+
+
+Writing index file salomeTools.idx
+(./salomeTools.aux)
+\openout1 = `salomeTools.aux'.
+
+LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for OT1/cmr/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for OMS/cmsy/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for OMX/cmex/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for U/cmr/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for TS1/cmr/m/n on input line 110.
+LaTeX Font Info: Try loading font information for TS1+cmr on input line 110.
+
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd
+File: ts1cmr.fd 2014/09/29 v2.5h Standard LaTeX font definitions
+)
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Checking defaults for PD1/pdf/m/n on input line 110.
+LaTeX Font Info: ... okay on input line 110.
+LaTeX Font Info: Try loading font information for T1+ptm on input line 110.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd
+File: t1ptm.fd 2001/06/04 font definitions for T1/ptm.
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp
+-pdf.mkii
+[Loading MPS to PDF converter (version 2006.09.02).]
+\scratchcounter=\count125
+\scratchdimen=\dimen141
+\scratchbox=\box40
+\nofMPsegments=\count126
+\nofMParguments=\count127
+\everyMPshowfont=\toks30
+\MPscratchCnt=\count128
+\MPscratchDim=\dimen142
+\MPnumerator=\count129
+\makeMPintoPDFobject=\count130
+\everyMPtoPDFconversion=\toks31
+)
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopd
+f-base.sty
+Package: epstopdf-base 2016/05/15 v2.6 Base part for package epstopdf
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.
+sty
+Package: grfext 2016/05/16 v1.2 Manage graphics extensions (HO)
+)
+Package epstopdf-base Info: Redefining graphics rule for `.eps' on input line 4
+38.
+Package grfext Info: Graphics extension search list:
+(grfext) [.pdf,.png,.jpg,.mps,.jpeg,.jbig2,.jb2,.PDF,.PNG,.JPG,.JPE
+G,.JBIG2,.JB2,.eps]
+(grfext) \AppendGraphicsExtensions on input line 456.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epst
+opdf-sys.cfg
+File: epstopdf-sys.cfg 2010/07/13 v1.3 Configuration of (r)epstopdf for TeX Liv
+e
+))
+\AtBeginShipoutBox=\box41
+Package hyperref Info: Link coloring ON on input line 110.
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref
+.sty
+Package: nameref 2016/05/21 v2.44 Cross-referencing by name of section
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/getti
+tlestring.sty
+Package: gettitlestring 2016/05/16 v1.5 Cleanup title references (HO)
+)
+\c@section@level=\count131
+)
+LaTeX Info: Redefining \ref on input line 110.
+LaTeX Info: Redefining \pageref on input line 110.
+LaTeX Info: Redefining \nameref on input line 110.
+ (./salomeTools.out) (./salomeTools.out)
+\@outlinefile=\write6
+\openout6 = `salomeTools.out'.
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 113--113
+
+ []
+
+LaTeX Font Info: Try loading font information for T1+phv on input line 113.
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd
+File: t1phv.fd 2001/06/04 scalable font definitions for T1/phv.
+)
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <24.88> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 113.
+LaTeX Font Info: Font shape `T1/phv/m/it' in size <17.28> not available
+(Font) Font shape `T1/phv/m/sl' tried instead on input line 113.
+LaTeX Font Info: Font shape `T1/phv/bx/it' in size <17.28> not available
+(Font) Font shape `T1/phv/b/it' tried instead on input line 113.
+LaTeX Font Info: Font shape `T1/phv/b/it' in size <17.28> not available
+(Font) Font shape `T1/phv/b/sl' tried instead on input line 113.
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <17.28> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 113.
+[1
+
+{/data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdf
+tex.map}] [2
+
+] (./salomeTools.toc
+LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <10> not available
+(Font) Font shape `T1/ptm/b/n' tried instead on input line 2.
+)
+\tf@toc=\write7
+\openout7 = `salomeTools.toc'.
+
+
+Adding blank page after the table of contents.
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <10> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 113.
+pdfTeX warning (ext4): destination with the same identifier (name{page.i}) has
+been already used, duplicate ignored
+<to be read again>
+ \relax
+l.113 \tableofcontents
+ [1
+
+]pdfTeX warning (ext4): destination with the same identifier (name{page.ii}) ha
+s been already used, duplicate ignored
+<to be read again>
+ \relax
+l.113 \tableofcontents
+ [2]
+<sat_about.png, id=139, 602.25pt x 301.125pt>
+File: sat_about.png Graphic file (type png)
+<use sat_about.png>
+Package pdftex.def Info: sat_about.png used on input line 117.
+(pdftex.def) Requested size: 602.24852pt x 301.12425pt.
+File: sat_about.png Graphic file (type png)
+<use sat_about.png>
+Package pdftex.def Info: sat_about.png used on input line 117.
+(pdftex.def) Requested size: 452.96788pt x 226.49104pt.
+
+Underfull \hbox (badness 10000) in paragraph at lines 121--122
+
+ []
+
+[1
+
+ <./sat_about.png>] [2
+
+]
+Chapter 1.
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <14.4> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 133.
+LaTeX Font Info: Try loading font information for T1+pcr on input line 140.
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
+File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
+)
+LaTeX Font Info: Font shape `T1/pcr/m/it' in size <9> not available
+(Font) Font shape `T1/pcr/m/sl' tried instead on input line 143.
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <12> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 158.
+LaTeX Font Info: Try loading font information for TS1+ptm on input line 163.
+
+
+(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd
+File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm.
+) [3]
+LaTeX Font Info: Font shape `T1/phv/bx/n' in size <9> not available
+(Font) Font shape `T1/phv/b/n' tried instead on input line 278.
+LaTeX Font Info: Font shape `T1/phv/bx/it' in size <9> not available
+(Font) Font shape `T1/phv/b/it' tried instead on input line 278.
+LaTeX Font Info: Font shape `T1/phv/b/it' in size <9> not available
+(Font) Font shape `T1/phv/b/sl' tried instead on input line 278.
+ [4] [5] [6]
+Chapter 2.
+[7
+
+]
+Underfull \hbox (badness 10000) in paragraph at lines 489--490
+
+ []
+
+[8] [9] [10] [11]
+Underfull \hbox (badness 10000) in paragraph at lines 816--817
+[]\T1/ptm/m/n/10 Create the vir-tual ap-pli-ca-tion di-rec-tory in the sa-lome-
+Tool ap-pli-ca-tion di-rec-tory
+ []
+
+[12]
+Underfull \hbox (badness 10000) in paragraph at lines 905--906
+[]\T1/ptm/m/n/10 The --terminal (or -t) dis-play the log di-rectly in the ter-m
+i-nal, through a [][]CLI[][]
+ []
+
+[13] [14]
+LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <9> not available
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 1088.
+ [15]
+Underfull \hbox (badness 8075) in paragraph at lines 1216--1219
+[]\T1/ptm/m/n/10 This com-mand will cre-ate an archive named \T1/pcr/m/n/10 SAL
+OME_xx.tgz \T1/ptm/m/n/10 in the work-ing di-rec-tory
+ []
+
+[16]
+Overfull \hbox (44.44682pt too wide) in paragraph at lines 1276--1277
+[]\T1/ptm/m/n/10 The ver-sion con-trol sys-tems known by this op-tion are [][]C
+VS[][] (https://fr.wikipedia.org/wiki/Concurrent_versions_system),
+ []
+
+[17] [18]
+Chapter 3.
+[19
+
+] [20] [21] [22
+
+]
+Chapter 4.
+LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <10> not available
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 1509.
+[23] [24] [25] [26] [27] [28] [29]
+Underfull \hbox (badness 10000) in paragraph at lines 2688--2688
+[]\T1/ptm/m/it/10 filename\T1/ptm/m/n/10 , \T1/ptm/m/it/10 ad-di-tional_env={}\
+T1/ptm/m/n/10 , \T1/ptm/m/it/10 for_package=None\T1/ptm/m/n/10 ,
+ []
+
+[30] [31] [32] [33] [34] [35] [36] [37]
+Underfull \hbox (badness 10000) in paragraph at lines 4104--4104
+[]\T1/ptm/m/it/10 config\T1/ptm/m/n/10 , \T1/ptm/m/it/10 silent_sysstd=False\T1
+/ptm/m/n/10 , \T1/ptm/m/it/10 all_in_terminal=False\T1/ptm/m/n/10 , \T1/ptm/m/i
+t/10 mi-
+ []
+
+[38] [39] [40] [41] [42] [43] [44] [45] [46] [47] [48] [49] [50] [51] [52]
+Underfull \hbox (badness 10000) in paragraph at lines 6286--6290
+[]\T1/ptm/m/n/10 Examples: makePath(`', `suf-fix') -> `suf-fix' makePath(`prefi
+x', `suf-fix') -> `pre-fix.suffix'
+ []
+
+[53] [54] [55] [56] [57] [58] [59] [60] [61] [62
+
+]
+Chapter 5.
+[63] [64
+
+] [65
+
+
+] (./salomeTools.ind [66
+
+
+]
+Underfull \hbox (badness 10000) in paragraph at lines 7--8
+[]\T1/ptm/m/n/10 add_comment() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 8--9
+[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.BatFileEnviron
+ []
+
+
+Underfull \hbox (badness 6188) in paragraph at lines 10--11
+[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 11--12
+[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.ScreenEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 12--13
+[]\T1/ptm/m/n/10 add_echo() (src.fileEnviron.ContextFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 14--15
+[]\T1/ptm/m/n/10 add_echo() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 18--19
+[]\T1/ptm/m/n/10 add_line() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 23--24
+[]\T1/ptm/m/n/10 add_simple_node() (src.xmlManager.XmlLogFile
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 24--25
+[]\T1/ptm/m/n/10 add_warning() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 25--26
+[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.ContextFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 27--28
+[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 28--29
+[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.ScreenEnviron
+ []
+
+
+Overfull \hbox (6.44356pt too wide) in paragraph at lines 32--33
+[]\T1/ptm/m/n/10 ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Overfull \hbox (10.33357pt too wide) in paragraph at lines 33--34
+[]\T1/ptm/m/n/10 ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 43--44
+[]\T1/ptm/m/n/10 append() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 47--48
+[]\T1/ptm/m/n/10 append_node_attrib() (src.xmlManager.XmlLogFile
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 48--49
+[]\T1/ptm/m/n/10 append_node_text() (src.xmlManager.XmlLogFile
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 50--51
+[]\T1/ptm/m/n/10 append_value() (src.fileEnviron.ContextFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 52--53
+[]\T1/ptm/m/n/10 append_value() (src.fileEnviron.LauncherFileEnviron
+ []
+
+[67
+
+]
+Underfull \hbox (badness 10000) in paragraph at lines 72--73
+[]\T1/ptm/m/n/10 BRIGHT_BACKGROUND
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 72--73
+\T1/ptm/m/n/10 (src.colorama.winterm.WinStyle at-tribute),
+ []
+
+
+Overfull \hbox (17.33417pt too wide) in paragraph at lines 79--80
+[]\T1/ptm/m/n/10 change_to_launcher() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 82--83
+[]\T1/ptm/m/n/10 check_config_has_application() (in mod-ule
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 99--100
+[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.BashFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 100--101
+[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.BatFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 102--103
+[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.FileEnviron
+ []
+
+
+Overfull \hbox (2.65422pt too wide) in paragraph at lines 103--104
+[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 104--105
+[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.ScreenEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 106--107
+[]\T1/ptm/m/n/10 complete_environment() (src.compilation.Builder
+ []
+
+
+Overfull \hbox (1.98415pt too wide) in paragraph at lines 121--122
+[]\T1/ptm/m/n/10 convert_ansi() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 127--128
+[]\T1/ptm/m/n/10 cursor_adjust() (src.colorama.winterm.WinTerm
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 145--146
+[]\T1/ptm/m/n/10 do_batch_script_build() (src.compilation.Builder
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 147--148
+[]\T1/ptm/m/n/10 do_python_script_build() (src.compilation.Builder
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 163--164
+[]\T1/ptm/m/n/10 erase_screen() (src.colorama.winterm.WinTerm
+ []
+
+[68]
+Overfull \hbox (12.3738pt too wide) in paragraph at lines 169--170
+[]\T1/ptm/m/n/10 extract_params() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 219--220
+[]\T1/ptm/m/n/10 get_node_text() (src.xmlManager.ReadXmlFile
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 220--221
+[]\T1/ptm/m/n/10 get_position() (src.colorama.winterm.WinTerm
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 226--227
+[]\T1/ptm/m/n/10 get_property_in_product_cfg() (in mod-ule
+ []
+
+
+Overfull \hbox (16.98376pt too wide) in paragraph at lines 233--234
+[]\T1/ptm/m/n/10 get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 240--241
+[]\T1/ptm/m/n/10 getRootAttrib() (src.xmlManager.ReadXmlFile
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 267--268
+[]\T1/ptm/m/n/10 is_defined() (src.fileEnviron.LauncherFileEnviron
+ []
+
+[69]
+Underfull \hbox (badness 10000) in paragraph at lines 269--270
+[]\T1/ptm/m/n/10 is_stream_closed() (in mod-ule
+ []
+
+
+Underfull \hbox (badness 5260) in paragraph at lines 289--290
+[]\T1/ptm/m/n/10 LIGHTBLACK_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 290--291
+[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiBack at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 291--292
+[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 292--293
+[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiBack
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 293--294
+[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 5490) in paragraph at lines 295--296
+[]\T1/ptm/m/n/10 LIGHTGREEN_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 296--297
+[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 297--298
+[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiFore
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 298--299
+[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiBack at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 299--300
+[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 7273) in paragraph at lines 301--302
+[]\T1/ptm/m/n/10 LIGHTWHITE_EX (src.colorama.ansi.AnsiFore at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 308--309
+[]\T1/ptm/m/n/10 load_cfg_environment()
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 308--309
+\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 319--320
+[]\T1/ptm/m/n/10 MAGENTA (src.colorama.winterm.WinColor at-
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 354--355
+[]\T1/ptm/m/n/10 parseKeyValuePair() (src.pyconf.ConfigReader
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 356--357
+[]\T1/ptm/m/n/10 parseMappingBody() (src.pyconf.ConfigReader
+ []
+
+[70]
+Underfull \hbox (badness 10000) in paragraph at lines 370--371
+[]\T1/ptm/m/n/10 prepare_testbase_from_dir() (src.test_module.Test
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 371--372
+[]\T1/ptm/m/n/10 prepare_testbase_from_git() (src.test_module.Test
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 372--373
+[]\T1/ptm/m/n/10 prepare_testbase_from_svn() (src.test_module.Test
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 376--377
+[]\T1/ptm/m/n/10 prepend() (src.fileEnviron.LauncherFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 379--380
+[]\T1/ptm/m/n/10 prepend_value() (src.fileEnviron.ContextFileEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 417--418
+[]\T1/ptm/m/n/10 put_txt_log_in_appli_log_dir()
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 443--444
+[]\T1/ptm/m/n/10 reset_all() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 448--449
+[]\T1/ptm/m/n/10 run_env_script() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 449--450
+[]\T1/ptm/m/n/10 run_env_script() (src.fileEnviron.ScreenEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 453--454
+[]\T1/ptm/m/n/10 run_simple_env_script()
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 453--454
+\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
+ []
+
+[71]
+Underfull \hbox (badness 10000) in paragraph at lines 475--476
+[]\T1/ptm/m/n/10 set_a_product() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 478--479
+[]\T1/ptm/m/n/10 set_console() (src.colorama.winterm.WinTerm
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 479--480
+[]\T1/ptm/m/n/10 set_cpp_env() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 481--482
+[]\T1/ptm/m/n/10 set_full_environ() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 482--483
+[]\T1/ptm/m/n/10 set_products() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 6445) in paragraph at lines 483--484
+[]\T1/ptm/m/n/10 set_python_libdirs() (src.environment.SalomeEnviron
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 484--485
+[]\T1/ptm/m/n/10 set_salome_generic_product_env()
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 484--485
+\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 485--486
+[]\T1/ptm/m/n/10 set_salome_minimal_product_env()
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 485--486
+\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 488--489
+[]\T1/ptm/m/n/10 SetConsoleTextAttribute() (in mod-ule
+ []
+
+
+Overfull \hbox (3.09416pt too wide) in paragraph at lines 492--493
+[]\T1/ptm/m/n/10 should_wrap() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 553--554
+[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 554--555
+[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.StreamWrapper
+ []
+
+
+Overfull \hbox (25.86401pt too wide) in paragraph at lines 559--560
+[]\T1/ptm/m/n/10 write_and_convert() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+
+Underfull \hbox (badness 10000) in paragraph at lines 562--563
+[]\T1/ptm/m/n/10 write_env_file() (src.environment.FileEnvWriter
+ []
+
+[72]
+Overfull \hbox (16.83371pt too wide) in paragraph at lines 563--564
+[]\T1/ptm/m/n/10 write_plain_text() (src.colorama.ansitowin32.AnsiToWin32
+ []
+
+[73
+
+])
+Package atveryend Info: Empty hook `BeforeClearDocument' on input line 7626.
+Package atveryend Info: Empty hook `AfterLastShipout' on input line 7626.
+ (./salomeTools.aux)
+Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 7626.
+Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 7626.
+
+Package rerunfilecheck Info: File `salomeTools.out' has not changed.
+(rerunfilecheck) Checksum: 30BE2611C6B1D9A21CC43B549476BD3F;1342.
+Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 7626.
+ )
+Here is how much of TeX's memory you used:
+ 10560 strings out of 492982
+ 172028 string characters out of 6124607
+ 264120 words of memory out of 5000000
+ 13256 multiletter control sequences out of 15000+600000
+ 66589 words of font info for 74 fonts, out of 8000000 for 9000
+ 1142 hyphenation exceptions out of 8191
+ 35i,12n,45p,411b,627s stack positions out of 5000i,500n,10000p,200000b,80000s
+{/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.
+enc}</data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courie
+r/ucrb8a.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/u
+rw/courier/ucrr8a.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf-dist/font
+s/type1/urw/courier/ucrro8a.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf
+-dist/fonts/type1/urw/helvetic/uhvb8a.pfb></data/tmplgls/wambeke/share/texlive/
+2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb></data/tmplgls/wambeke/sha
+re/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb></data/tmplgls/w
+ambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb></data/tm
+plgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb></
+data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8
+a.pfb>
+Output written on salomeTools.pdf (77 pages, 667449 bytes).
+PDF statistics:
+ 1787 PDF objects out of 2073 (max. 8388607)
+ 1680 compressed objects within 17 object streams
+ 675 named destinations out of 1000 (max. 500000)
+ 190 words of extra memory for PDF output out of 10000 (max. 10000000)
+
--- /dev/null
+\BOOKMARK [0][-]{chapter.1}{Quick start}{}% 1
+\BOOKMARK [1][-]{section.1.1}{Installation}{chapter.1}% 2
+\BOOKMARK [1][-]{section.1.2}{Configuration}{chapter.1}% 3
+\BOOKMARK [1][-]{section.1.3}{Usage of SAlomeTools}{chapter.1}% 4
+\BOOKMARK [0][-]{chapter.2}{List of Commands}{}% 5
+\BOOKMARK [1][-]{section.2.1}{Command config}{chapter.2}% 6
+\BOOKMARK [1][-]{section.2.2}{Command prepare}{chapter.2}% 7
+\BOOKMARK [1][-]{section.2.3}{Command compile}{chapter.2}% 8
+\BOOKMARK [1][-]{section.2.4}{Command launcher}{chapter.2}% 9
+\BOOKMARK [1][-]{section.2.5}{Command application}{chapter.2}% 10
+\BOOKMARK [1][-]{section.2.6}{Command log}{chapter.2}% 11
+\BOOKMARK [1][-]{section.2.7}{Command environ}{chapter.2}% 12
+\BOOKMARK [1][-]{section.2.8}{Command clean}{chapter.2}% 13
+\BOOKMARK [1][-]{section.2.9}{Command package}{chapter.2}% 14
+\BOOKMARK [1][-]{section.2.10}{Command generate}{chapter.2}% 15
+\BOOKMARK [0][-]{chapter.3}{Developer documentation}{}% 16
+\BOOKMARK [1][-]{section.3.1}{Add a user custom command}{chapter.3}% 17
+\BOOKMARK [0][-]{chapter.4}{Code documentation}{}% 18
+\BOOKMARK [1][-]{section.4.1}{src}{chapter.4}% 19
+\BOOKMARK [0][-]{chapter.5}{Release Notes}{}% 20
+\BOOKMARK [1][-]{section.5.1}{Release notes}{chapter.5}% 21
+\BOOKMARK [0][-]{section*.532}{Python Module Index}{}% 22
+\BOOKMARK [0][-]{section*.533}{Index}{}% 23
--- /dev/null
+% Generated by Sphinx.
+\def\sphinxdocclass{report}
+\documentclass[a4paper,10pt,english]{sphinxmanual}
+\usepackage[utf8]{inputenc}
+\DeclareUnicodeCharacter{00A0}{\nobreakspace}
+\usepackage[T1]{fontenc}
+\usepackage{babel}
+\usepackage{times}
+\usepackage[Bjarne]{fncychap}
+\usepackage{longtable}
+\usepackage{sphinx}
+\usepackage{multirow}
+
+
+\title{salomeTools Documentation}
+\date{April 24, 2018}
+\release{5.0.0dev}
+\author{CEA DEN/DANS/DM2S/STMF/LGLS}
+\newcommand{\sphinxlogo}{}
+\renewcommand{\releasename}{Release}
+\makeindex
+
+\makeatletter
+\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
+ \let\PYG@ul=\relax \let\PYG@tc=\relax%
+ \let\PYG@bc=\relax \let\PYG@ff=\relax}
+\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
+\def\PYG@toks#1+{\ifx\relax#1\empty\else%
+ \PYG@tok{#1}\expandafter\PYG@toks\fi}
+\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
+ \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
+\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
+
+\def\PYG@tok@gd{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
+\def\PYG@tok@gu{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\def\PYG@tok@gt{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.25,0.82}{##1}}}
+\def\PYG@tok@gs{\let\PYG@bf=\textbf}
+\def\PYG@tok@gr{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\def\PYG@tok@cm{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\def\PYG@tok@vg{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\def\PYG@tok@m{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@mh{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@cs{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\colorbox[rgb]{1.00,0.94,0.94}{##1}}}
+\def\PYG@tok@ge{\let\PYG@it=\textit}
+\def\PYG@tok@vc{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\def\PYG@tok@il{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@go{\def\PYG@tc##1{\textcolor[rgb]{0.19,0.19,0.19}{##1}}}
+\def\PYG@tok@cp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@gi{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
+\def\PYG@tok@gh{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
+\def\PYG@tok@ni{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
+\def\PYG@tok@nl{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
+\def\PYG@tok@nn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\def\PYG@tok@no{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
+\def\PYG@tok@na{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@nb{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@nc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\def\PYG@tok@nd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
+\def\PYG@tok@ne{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@nf{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\def\PYG@tok@si{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
+\def\PYG@tok@s2{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@vi{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\def\PYG@tok@nt{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
+\def\PYG@tok@nv{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\def\PYG@tok@s1{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@gp{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\def\PYG@tok@sh{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@ow{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@sx{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\def\PYG@tok@bp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@c1{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\def\PYG@tok@kc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@c{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\def\PYG@tok@mf{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@err{\def\PYG@bc##1{\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{##1}}}
+\def\PYG@tok@kd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@ss{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
+\def\PYG@tok@sr{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
+\def\PYG@tok@mo{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@mi{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\def\PYG@tok@kn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@o{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
+\def\PYG@tok@kr{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@s{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@kp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@w{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
+\def\PYG@tok@kt{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
+\def\PYG@tok@sc{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@sb{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@k{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\def\PYG@tok@se{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\def\PYG@tok@sd{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+
+\def\PYGZbs{\char`\\}
+\def\PYGZus{\char`\_}
+\def\PYGZob{\char`\{}
+\def\PYGZcb{\char`\}}
+\def\PYGZca{\char`\^}
+\def\PYGZsh{\char`\#}
+\def\PYGZpc{\char`\%}
+\def\PYGZdl{\char`\$}
+\def\PYGZti{\char`\~}
+% for compatibility with earlier versions
+\def\PYGZat{@}
+\def\PYGZlb{[}
+\def\PYGZrb{]}
+\makeatother
+
+\begin{document}
+
+\maketitle
+\tableofcontents
+\phantomsection\label{index::doc}
+
+
+{\hfill\scalebox{1.000000}{\includegraphics{sat_about.png}}\hfill}
+
+\begin{notice}{warning}{Warning:}
+This documentation is under construction.
+\end{notice}
+
+The \textbf{Sa}lome\textbf{T}ools (sat) is a suite of commands
+that can be used to perform operations on \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org).
+
+For example, sat allows you to compile SALOME's codes
+(prerequisites, products)
+create application, run tests, create package, etc.
+
+This utility code is a set of \href{https://docs.python.org/2.7}{Python} (https://docs.python.org/2.7) scripts files.
+
+
+\chapter{Quick start}
+\label{index:svn}\label{index:quick-start}\label{index:salome-tools}
+
+\section{Installation}
+\label{installation_of_sat:installation}\label{installation_of_sat::doc}
+Usually user could find (and use) command \textbf{sat} directly after a `detar' installation of SALOME.
+
+\begin{Verbatim}[commandchars=\\\{\}]
+tar -xf .../SALOME\PYGZus{}xx.tgz
+\PYG{n+nb}{cd }SALOME\PYGZus{}xx
+ls -l sat \PYG{c}{\PYGZsh{} sat -\textgreater{} salomeTools/sat}
+\end{Verbatim}
+
+Python package (scripts of salomeTools) actually remains in directory \emph{salomeTools}.
+
+
+\section{Configuration}
+\label{configuration:configuration}\label{configuration::doc}
+\emph{salomeTools} uses files to store its configuration parameters.
+
+There are several configuration files which are loaded by salomeTools in a specific order.
+When all the files are loaded a \emph{config} object is created.
+Then, this object is passed to all command scripts.
+
+
+\subsection{Syntax}
+\label{configuration:syntax}
+The configuration files use a python-like structure format
+(see \href{http://www.red-dove.com/config-doc/}{config module} (http://www.red-dove.com/config-doc/) for a complete description).
+\begin{itemize}
+\item {}
+\textbf{\{\}} define a dictionary,
+
+\item {}
+\textbf{{[}{]}} define a list,
+
+\item {}
+\textbf{@} can be used to include a file,
+
+\item {}
+\textbf{\$prefix} reference to another parameter (ex: \code{\$PRODUCT.name}),
+
+\item {}
+\textbf{\#} comments.
+
+\end{itemize}
+
+\begin{notice}{note}{Note:}
+in this documentation a reference to a configuration parameter will be noted \code{XXX.YYY}.
+\end{notice}
+
+
+\subsection{Description}
+\label{configuration:description}
+
+\subsubsection{VARS section}
+\label{configuration:vars-section}\label{configuration:id1}
+\begin{DUlineblock}{0em}
+\item[] This section is dynamically created by salomeTools at run time.
+\item[] It contains information about the environment: date, time, OS, architecture etc.
+\end{DUlineblock}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\# to get the current setting
+sat config --value VARS
+\end{Verbatim}
+
+
+\subsubsection{PRODUCTS section}
+\label{configuration:products-section}
+\begin{DUlineblock}{0em}
+\item[] This section is defined in the product file.
+\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
+\end{DUlineblock}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\# to get the current setting
+sat config SALOME-xx --value PRODUCTS
+\end{Verbatim}
+
+
+\subsubsection{APPLICATION section}
+\label{configuration:application-section}
+\begin{DUlineblock}{0em}
+\item[] This section is optional, it is also defined in the product file.
+\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use.
+\end{DUlineblock}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\# to get the current setting
+sat config SALOME-xx --value APPLICATION
+\end{Verbatim}
+
+
+\subsubsection{USER section}
+\label{configuration:user-section}\label{configuration:id2}
+This section is defined by the user configuration file,
+\code{\textasciitilde{}/.salomeTools/salomeTools.pyconf}.
+
+The \code{USER} section defines some parameters (not exhaustive):
+\begin{itemize}
+\item {}
+\textbf{workDir} :
+\begin{quote}
+
+\begin{DUlineblock}{0em}
+\item[] The working directory.
+\item[] Each product will be usually installed here (in sub-directories).
+\end{DUlineblock}
+\end{quote}
+
+\item {}
+\textbf{browser} : The web browser to use (\emph{firefox}).
+
+\item {}
+\textbf{editor} : The editor to use (\emph{vi, pluma}).
+
+\item {}
+and other user preferences.
+
+\end{itemize}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\# to get the current setting
+sat config SALOME-xx --value USER
+\end{Verbatim}
+
+
+\section{Usage of SAlomeTools}
+\label{usage_of_sat:svn}\label{usage_of_sat:usage-of-salometools}\label{usage_of_sat::doc}
+
+\subsection{Usage}
+\label{usage_of_sat:usage}
+sat usage is a Command Line Interface (\href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI} (https://en.wikipedia.org/wiki/Command-line\_interface)).
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}\PYG{n+nb}{command}\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]}
+\end{Verbatim}
+
+
+\subsubsection{Options of sat}
+\label{usage_of_sat:options-of-sat}
+Useful \emph{not exhaustive} generic options of \emph{sat} CLI.
+
+
+\paragraph{\emph{--help or -h}}
+\label{usage_of_sat:help-or-h}
+Get help as simple text.
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat --help \PYG{c}{\PYGZsh{} get the list of existing commands}
+sat --help compile \PYG{c}{\PYGZsh{} get the help on a specific command 'compile'}
+\end{Verbatim}
+
+
+\paragraph{\emph{--debug or -g}}
+\label{usage_of_sat:debug-or-g}
+Execution in debug mode allows to see more trace and \emph{stack} if an exception is raised.
+
+
+\paragraph{\emph{--verbose or -v}}
+\label{usage_of_sat:verbose-or-v}
+Change verbosity level (default is 3).
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} for product 'SALOME\PYGZus{}xx' for example}
+\PYG{c}{\PYGZsh{} execute compile command in debug mode with trace level 4}
+sat -g -v 4 compile SALOME\PYGZus{}xx
+\end{Verbatim}
+
+
+\subsection{Build a SALOME product}
+\label{usage_of_sat:build-a-salome-product}
+
+\subsubsection{Get the list of available products}
+\label{usage_of_sat:get-the-list-of-available-products}
+To get the list of the current available products in your context:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config --list
+\end{Verbatim}
+
+
+\subsubsection{Prepare sources of a product}
+\label{usage_of_sat:prepare-sources-of-a-product}
+To prepare (get) \emph{all} the sources of a product (\emph{SALOME\_xx} for example):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat prepare SALOME\PYGZus{}xx
+\end{Verbatim}
+
+\begin{DUlineblock}{0em}
+\item[] The sources are usually copied in directories
+\item[] \emph{\$USER.workDir + SALOME\_xx... + SOURCES + \$PRODUCT.name}
+\end{DUlineblock}
+
+
+\subsubsection{Compile SALOME}
+\label{usage_of_sat:compile-salome}
+To compile products:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} compile all prerequisites/products}
+sat compile SALOME\PYGZus{}xx
+
+\PYG{c}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet}
+sat compile SALOME\PYGZus{}xx --products KERNEL,SAMPLES
+
+\PYG{c}{\PYGZsh{} compile only 2 products, unconditionaly}
+sat compile SALOME\PYGZus{}xx ---products SAMPLES --clean\PYGZus{}all
+\end{Verbatim}
+
+\begin{DUlineblock}{0em}
+\item[] The products are usually build in the directories
+\item[] \emph{\$USER.workDir + SALOME\_xx... + BUILD + \$PRODUCT.name}
+\item[]
+\item[] The products are usually installed in the directories
+\item[] \emph{\$USER.workDir + SALOME\_xx... + INSTALL + \$PRODUCT.name}
+\end{DUlineblock}
+
+
+\chapter{List of Commands}
+\label{index:list-of-commands}
+
+\section{Command config}
+\label{commands/config:svn}\label{commands/config:command-config}\label{commands/config::doc}
+
+\subsection{Description}
+\label{commands/config:description}
+The \textbf{config} command manages sat configuration.
+It allows display, manipulation and operation on configuration files
+
+
+\subsection{Usage}
+\label{commands/config:usage}\begin{itemize}
+\item {}
+Edit the user personal configuration file \code{\$HOME/.salomeTools/SAT.pyconf}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config --edit
+\end{Verbatim}
+
+\item {}
+List the available applications (they come from the sat projects defined in \code{data/local.pyconf}:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config --list
+\end{Verbatim}
+
+\item {}
+Edit the configuration of an application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config \textless{}application\textgreater{} --edit
+\end{Verbatim}
+
+\item {}
+Copy an application configuration file into the user personal directory:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config \textless{}application\textgreater{} --copy [new\_name]
+\end{Verbatim}
+
+\item {}
+\begin{DUlineblock}{0em}
+\item[] Print the value of a configuration parameter.
+\item[] Use the automatic completion to get recursively the parameter names.
+\item[] Use \emph{--no\_label} option to get \emph{only} the value, \emph{without} label (useful in automatic scripts).
+\item[] Examples (with \emph{SALOME-xx} as \emph{SALOME-8.4.0} ):
+\end{DUlineblock}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} sat config --value \textless{}parameter\PYGZus{}path\textgreater{}}
+sat config --value . \PYG{c}{\PYGZsh{} all the configuration}
+sat config --value LOCAL
+sat config --value LOCAL.workdir
+
+\PYG{c}{\PYGZsh{} sat config \textless{}application\textgreater{} --value \textless{}parameter\PYGZus{}path\textgreater{}}
+sat config SALOME-xx --value APPLICATION.workdir
+sat config SALOME-xx --no\PYGZus{}label --value APPLICATION.workdir
+\end{Verbatim}
+
+\item {}
+\begin{DUlineblock}{0em}
+\item[] Print in one-line-by-value mode the value of a configuration parameter,
+\item[] with its source \emph{expression}, if any.
+\item[] This is a debug mode, useful for developers.
+\item[] Prints the parameter path, the source expression if any, and the final value:
+\end{DUlineblock}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config SALOME-xx -g USER
+\end{Verbatim}
+
+\begin{notice}{note}{Note:}
+And so, \emph{not only for fun}, to get \textbf{all expressions} of configuration
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config SALOME-xx -g . \textbar{} grep -e \PYG{l+s+s2}{"--\textgreater{}"}
+\end{Verbatim}
+\end{notice}
+
+\item {}
+Print the patches that are applied:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config SALOME-xx --show\_patchs
+\end{Verbatim}
+
+\item {}
+Get information on a product configuration:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} sat config \textless{}application\textgreater{} --info \textless{}product\textgreater{}}
+sat config SALOME-xx --info KERNEL
+sat config SALOME-xx --info qt
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/config:some-useful-configuration-pathes}
+Exploring a current configuration.
+\begin{itemize}
+\item {}
+\textbf{PATHS}: To get list of directories where to find files.
+
+\item {}
+\textbf{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).
+
+\end{itemize}
+
+sat commands:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config SALOME-xx -v PATHS
+sat config SALOME-xx -v USERS
+\end{Verbatim}
+
+
+\section{Command prepare}
+\label{commands/prepare:svn}\label{commands/prepare:command-prepare}\label{commands/prepare::doc}
+
+\subsection{Description}
+\label{commands/prepare:description}
+The \textbf{prepare} command brings the sources of an application in the \emph{sources
+application directory}, in order to compile them with the compile command.
+
+The sources can be prepared from VCS software (\emph{cvs, svn, git}), an archive or a directory.
+
+\begin{notice}{warning}{Warning:}
+When sat prepares a product, it first removes the
+existing directory, except if the development mode is activated.
+When you are working on a product, you need to declare in
+the application configuration this product in \textbf{dev} mode.
+\end{notice}
+
+
+\subsection{Remarks}
+\label{commands/prepare:remarks}
+
+\subsubsection{VCS bases (git, svn, cvs)}
+\label{commands/prepare:vcs-bases-git-svn-cvs}
+The \emph{prepare} command does not manage authentication on the cvs server.
+For example, to prepare modules from a cvs server, you first need to login once.
+
+To avoid typing a password for each product,
+you may use a ssh key with passphrase, or store your password
+(in .cvspass or .gitconfig files).
+If you have security concerns, it is also possible to use
+a bash agent and type your password only once.
+
+
+\subsubsection{Dev mode}
+\label{commands/prepare:dev-mode}
+By default \emph{prepare} uses \emph{export} mode: it creates an image
+of the sources, corresponding to the tag or branch specified,
+without any link to the VCS base.
+To perform a \emph{checkout} (svn, cvs) or a \emph{git clone} (git),
+you need to declare the product in dev mode in your application configuration:
+edit the application configuration file (pyconf) and modify the product declaration:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config \textless{}application\textgreater{} -e
+\PYG{c}{\PYGZsh{} and edit the product section:}
+\PYG{c}{\PYGZsh{} \textless{}product\textgreater{} : \PYGZob{}tag : "my\PYGZus{}tag", dev : "yes", debug : "yes"\PYGZcb{}}
+\end{Verbatim}
+
+The first time you will execute the \emph{sat prepare} command,
+your module will be downloaded in \emph{checkout} mode
+(inside the SOURCES directory of the application.
+Then, you can develop in this repository, and finally push
+them in the base when they are ready.
+If you type during the development process by mistake
+a \emph{sat prepare} command, the sources in dev mode will
+not be altered/removed (Unless you use -f option)
+
+
+\subsection{Usage}
+\label{commands/prepare:usage}\begin{itemize}
+\item {}
+Prepare the sources of a complete application in SOURCES directory (all products):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat prepare \textless{}application\textgreater{}
+\end{Verbatim}
+
+\item {}
+Prepare only some modules:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat prepare \textless{}application\textgreater{} --products \textless{}product1\textgreater{},\textless{}product2\textgreater{} ...
+\end{Verbatim}
+
+\item {}
+Use --force to force to prepare the products in development mode
+(this will remove the sources and do a new clone/checkout):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat prepare \textless{}application\textgreater{} --force
+\end{Verbatim}
+
+\item {}
+Use --force\_patch to force to apply patch to the products
+in development mode (otherwise they are not applied):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat prepare \textless{}application\textgreater{} --force\_patch
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/prepare:some-useful-configuration-pathes}
+Command \emph{sat prepare} uses the \emph{pyconf file configuration} of each product to know how to get the sources.
+
+\begin{notice}{note}{Note:}
+to verify configuration of a product, and get name of this \emph{pyconf files configuration}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat config \textless{}application\textgreater{} --info \textless{}product\textgreater{}
+\end{Verbatim}
+\end{notice}
+\begin{itemize}
+\item {}
+\textbf{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.
+
+\item {}
+\textbf{git\_info} : (used if get\_method = git) information to prepare sources from git.
+
+\item {}
+\textbf{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.
+
+\item {}
+\textbf{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.
+
+\item {}
+\textbf{archive\_info} : (used if get\_method = archive) the path to the archive.
+
+\item {}
+\textbf{dir\_info} : (used if get\_method = dir) the directory with the sources.
+
+\end{itemize}
+
+
+\section{Command compile}
+\label{commands/compile:svn}\label{commands/compile:command-compile}\label{commands/compile::doc}
+
+\subsection{Description}
+\label{commands/compile:description}
+The \textbf{compile} command allows compiling the products of a \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) application.
+
+
+\subsection{Usage}
+\label{commands/compile:usage}\begin{itemize}
+\item {}
+Compile a complete application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{}
+\end{Verbatim}
+
+\item {}
+Compile only some products:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products \textless{}product1\textgreater{},\textless{}product2\textgreater{} ...
+\end{Verbatim}
+
+\item {}
+Use \emph{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \emph{sat log} command):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat -t compile \textless{}application\textgreater{} --products \textless{}product1\textgreater{}
+\end{Verbatim}
+
+\item {}
+Compile a module and its dependencies:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products med --with\_fathers
+\end{Verbatim}
+
+\item {}
+Compile a module and the modules depending on it (for example plugins):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products med --with\_children
+\end{Verbatim}
+
+\item {}
+Clean the build and install directories before starting compilation:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products GEOM --clean\_all
+\end{Verbatim}
+
+\begin{notice}{note}{Note:}
+\begin{DUlineblock}{0em}
+\item[] a warning will be shown if option \emph{--products} is missing
+\item[] (as it will clean everything)
+\end{DUlineblock}
+\end{notice}
+
+\item {}
+Clean only the install directories before starting compilation:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --clean\_install
+\end{Verbatim}
+
+\item {}
+Add options for make:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products \textless{}product\textgreater{} --make\_flags \textless{}flags\textgreater{}
+\end{Verbatim}
+
+\item {}
+Use the \emph{--check} option to execute the unit tests after compilation:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --check
+\end{Verbatim}
+
+\item {}
+Remove the build directory after successful compilation (some build directory like qt are big):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --products qt --clean\_build\_after
+\end{Verbatim}
+
+\item {}
+Stop the compilation as soon as the compilation of a module fails:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}product\textgreater{} --stop\_first\_fail
+\end{Verbatim}
+
+\item {}
+Do not compile, just show if products are installed or not, and where is the installation:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat compile \textless{}application\textgreater{} --show
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/compile:some-useful-configuration-pathes}
+The way to compile a product is defined in the \emph{pyconf file configuration}.
+The main options are:
+\begin{itemize}
+\item {}
+\textbf{build\_source} : the method used to build the product (cmake/autotools/script)
+
+\item {}
+\textbf{compil\_script} : the compilation script if build\_source is equal to ``script''
+
+\item {}
+\textbf{cmake\_options} : additional options for cmake.
+
+\item {}
+\textbf{nb\_proc} : number of jobs to use with make for this product.
+
+\end{itemize}
+
+
+\section{Command launcher}
+\label{commands/launcher:svn}\label{commands/launcher:command-launcher}\label{commands/launcher::doc}
+
+\subsection{Description}
+\label{commands/launcher:description}
+The \textbf{launcher} command creates a SALOME launcher, a python script file to start \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org).
+
+
+\subsection{Usage}
+\label{commands/launcher:usage}\begin{itemize}
+\item {}
+Create a launcher:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{}
+\end{Verbatim}
+
+Generate a launcher in the application directory, i.e \code{\$APPLICATION.workdir}.
+
+\item {}
+Create a launcher with a given name (default name is \code{APPLICATION.profile.launcher\_name})
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{} --name ZeLauncher
+\end{Verbatim}
+
+The launcher will be called \emph{ZeLauncher}.
+
+\item {}
+Set a specific resources catalog:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{} --catalog \textless{}path of a salome resources catalog\textgreater{}
+\end{Verbatim}
+
+Note that the catalog specified will be copied to the profile directory.
+
+\item {}
+Generate the catalog for a list of machines:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{} --gencat \textless{}list of machines\textgreater{}
+\end{Verbatim}
+
+This will create a catalog by querying each machine (memory, number of processor) with ssh.
+
+\item {}
+Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{} --use\_mesa
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Configuration}
+\label{commands/launcher:configuration}
+Some useful configuration pathes:
+\begin{itemize}
+\item {}
+\textbf{APPLICATION.profile}
+\begin{itemize}
+\item {}
+\textbf{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
+
+\item {}
+\textbf{launcher\_name} : the name of the launcher.
+
+\end{itemize}
+
+\end{itemize}
+
+
+\section{Command application}
+\label{commands/application:svn}\label{commands/application::doc}\label{commands/application:command-application}
+
+\subsection{Description}
+\label{commands/application:description}
+The \textbf{application} command creates a virtual \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) application.
+Virtual SALOME applications are used to start SALOME when distribution is needed.
+
+
+\subsection{Usage}
+\label{commands/application:usage}\begin{itemize}
+\item {}
+Create an application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat application \textless{}application\textgreater{}
+\end{Verbatim}
+
+Create the virtual application directory in the salomeTool application directory \code{\$APPLICATION.workdir}.
+
+\item {}
+Give a name to the application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat application \textless{}application\textgreater{} --name \textless{}my\_application\_name\textgreater{}
+\end{Verbatim}
+
+\emph{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \code{\$APPLICATION.virtual\_app.name}.
+
+\item {}
+Change the directory where the application is created:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat application \textless{}application\textgreater{} --target \textless{}my\_application\_directory\textgreater{}
+\end{Verbatim}
+
+\item {}
+Set a specific \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) resources catalog (it will be used for the distribution of components on distant machines):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat application \textless{}application\textgreater{} --catalog \textless{}path\_to\_catalog\textgreater{}
+\end{Verbatim}
+
+Note that the catalog specified will be copied to the application directory.
+
+\item {}
+Generate the catalog for a list of machines:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat application \textless{}application\textgreater{} --gencat machine1,machine2,machine3
+\end{Verbatim}
+
+This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
+
+\item {}
+Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat launcher \textless{}application\textgreater{} --use\_mesa
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/application:some-useful-configuration-pathes}
+The virtual application can be configured with the virtual\_app section of the configutation file.
+\begin{itemize}
+\item {}
+\textbf{APPLICATION.virtual\_app}
+\begin{itemize}
+\item {}
+\textbf{name} : name of the launcher (to replace the default runAppli).
+
+\item {}
+\textbf{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \code{\$name + \_appli}.
+
+\end{itemize}
+
+\end{itemize}
+
+
+\section{Command log}
+\label{commands/log:svn}\label{commands/log:command-log}\label{commands/log::doc}
+
+\subsection{Description}
+\label{commands/log:description}
+The \textbf{log} command displays sat log in a web browser or in a terminal.
+
+
+\subsection{Usage}
+\label{commands/log:usage}\begin{itemize}
+\item {}
+Show (in a web browser) the log of the commands corresponding to an application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log \textless{}application\textgreater{}
+\end{Verbatim}
+
+\item {}
+Show the log for commands that do not use any application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log
+\end{Verbatim}
+
+\item {}
+The --terminal (or -t) display the log directly in the terminal, through a \href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI} (https://en.wikipedia.org/wiki/Command-line\_interface) interactive menu:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log \textless{}application\textgreater{} --terminal
+\end{Verbatim}
+
+\item {}
+The --last option displays only the last command:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log \textless{}application\textgreater{} --last
+\end{Verbatim}
+
+\item {}
+To access the last compilation log in terminal mode, use --last\_terminal option:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log \textless{}application\textgreater{} --last\_terminal
+\end{Verbatim}
+
+\item {}
+The --clean (int) option erases the n older log files and print the number of remaining log files:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat log \textless{}application\textgreater{} --clean 50
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/log:some-useful-configuration-pathes}\begin{itemize}
+\item {}
+\textbf{USER}
+\begin{itemize}
+\item {}
+\textbf{browser} : The browser used to show the log (by default \emph{firefox}).
+
+\item {}
+\textbf{log\_dir} : The directory used to store the log files.
+
+\end{itemize}
+
+\end{itemize}
+
+
+\section{Command environ}
+\label{commands/environ:svn}\label{commands/environ:command-environ}\label{commands/environ::doc}
+
+\subsection{Description}
+\label{commands/environ:description}
+The \textbf{environ} command generates the environment files used
+to run and compile your application (as \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) is an example).
+
+\begin{notice}{note}{Note:}
+these files are \textbf{not} required,
+salomeTool set the environment himself, when compiling.
+And so does the salome launcher.
+
+These files are useful when someone wants to check the environment.
+They could be used in debug mode to set the environment for \emph{gdb}.
+\end{notice}
+
+The configuration part at the end of this page explains how
+to specify the environment used by sat (at build or run time),
+and saved in some files by \emph{sat environ} command.
+
+
+\subsection{Usage}
+\label{commands/environ:usage}\begin{itemize}
+\item {}
+Create the shell environment files of the application:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat environ \textless{}application\textgreater{}
+\end{Verbatim}
+
+\item {}
+Create the environment files of the application for a given shell.
+Options are bash, bat (for windows) and cfg (the configuration format used by \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org)):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat environ \textless{}application\textgreater{} --shell [bash\textbar{}cfg\textbar{}all]
+\end{Verbatim}
+
+\item {}
+Use a different prefix for the files (default is `env'):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} This will create file \textless{}prefix\textgreater{}\PYGZus{}launch.sh, \textless{}prefix\textgreater{}\PYGZus{}build.sh}
+sat environ \textless{}application\textgreater{} --prefix \textless{}prefix\textgreater{}
+\end{Verbatim}
+
+\item {}
+Use a different target directory for the files:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh}
+\PYG{c}{\PYGZsh{} in the directory corresponding to \textless{}path\textgreater{}}
+sat environ \textless{}application\textgreater{} --target \textless{}path\textgreater{}
+\end{Verbatim}
+
+\item {}
+Generate the environment files only with the given products:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} This will create the environment files only for the given products}
+\PYG{c}{\PYGZsh{} and their prerequisites.}
+\PYG{c}{\PYGZsh{} It is useful when you want to visualise which environment uses}
+\PYG{c}{\PYGZsh{} sat to compile a given product.}
+sat environ \textless{}application\textgreater{} --product \textless{}product1\textgreater{},\textless{}product2\textgreater{}, ...
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Configuration}
+\label{commands/environ:configuration}
+The specification of the environment can be done through several mechanisms.
+\begin{enumerate}
+\item {}
+For salome products (the products with the property \code{is\_SALOME\_module} as \code{yes}) the environment is set automatically by sat, in respect with \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) requirements.
+
+\item {}
+For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
+
+\end{enumerate}
+
+Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
+In the following example, we prepend \emph{\textless{}install\_dir\textgreater{}/lib} to \code{LD\_LIBRARY\_PATH} (note the \emph{left first} underscore), append \emph{\textless{}install\_dir\textgreater{}/lib} to \code{PYTHONPATH} (note the \emph{right last} underscore), and set \code{LAPACK\_ROOT\_DIR} to \emph{\textless{}install\_dir\textgreater{}}:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+environ :
+\PYGZob{}
+ \_LD\_LIBRARY\_PATH : \$install\_dir + \$VARS.sep + "lib"
+ PYTHONPATH\_ : \$install\_dir + \$VARS.sep + "lib"
+ LAPACK\_ROOT\_DIR : \$install\_dir
+\PYGZcb{}
+\end{Verbatim}
+
+It is possible to distinguish the build environment from the launch environment: use a subsection called \emph{build} or \emph{launch}. In the example below, \code{LD\_LIBRARY\_PATH} and \code{PYTHONPATH} are only modified at run time, not at compile time:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+environ :
+\PYGZob{}
+ build :
+ \PYGZob{}
+ LAPACK\_ROOT\_DIR : \$install\_dir
+ \PYGZcb{}
+ launch :
+ \PYGZob{}
+ LAPACK\_ROOT\_DIR : \$install\_dir
+ \_LD\_LIBRARY\_PATH : \$install\_dir + \$VARS.sep + "lib"
+ PYTHONPATH\_ : \$install\_dir + \$VARS.sep + "lib"
+ \PYGZcb{}
+\PYGZcb{}
+\end{Verbatim}
+\begin{enumerate}
+\setcounter{enumi}{2}
+\item {}
+The last possibility is to set the environment with a python script. The script should be provided in the \emph{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \code{environ.env\_script}:
+
+\end{enumerate}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{environ} \PYG{p}{:}
+\PYG{p}{\PYGZob{}}
+ \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s}{'}\PYG{l+s}{lapack.py}\PYG{l+s}{'}
+\PYG{p}{\PYGZcb{}}
+\end{Verbatim}
+
+Please note that the two modes are complementary and are both taken into account.
+Most of the time, the first mode is sufficient.
+
+The second mode can be used when the environment has to be set programmatically.
+The developer implements a handle (as a python method)
+which is called by sat to set the environment.
+Here is an example:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{}!/usr/bin/env python}
+\PYG{c}{\PYGZsh{}-*- coding:utf-8 -*-}
+
+\PYG{k+kn}{import} \PYG{n+nn}{os.path}
+\PYG{k+kn}{import} \PYG{n+nn}{platform}
+
+\PYG{k}{def} \PYG{n+nf}{set\PYGZus{}env}\PYG{p}{(}\PYG{n}{env}\PYG{p}{,} \PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{n}{version}\PYG{p}{)}\PYG{p}{:}
+ \PYG{n}{env}\PYG{o}{.}\PYG{n}{set}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{TRUST\PYGZus{}ROOT\PYGZus{}DIR}\PYG{l+s}{"}\PYG{p}{,}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{)}
+ \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{PATH}\PYG{l+s}{'}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{bin}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)}
+ \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{PATH}\PYG{l+s}{'}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{include}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)}
+ \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s}{'}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{lib}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)}
+ \PYG{k}{return}
+\end{Verbatim}
+
+SalomeTools defines four handles:
+\begin{itemize}
+\item {}
+\textbf{set\_env(env, prereq\_dir, version)} : used at build and run time.
+
+\item {}
+\textbf{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)
+
+\item {}
+\textbf{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)
+
+\item {}
+\textbf{set\_native\_env(env)} : used only for native products, at build and run time.
+
+\end{itemize}
+
+
+\section{Command clean}
+\label{commands/clean:svn}\label{commands/clean:command-clean}\label{commands/clean::doc}
+
+\subsection{Description}
+\label{commands/clean:description}
+The \textbf{clean} command removes products in the \emph{source, build, or install} directories of an application. Theses directories are usually named \code{SOURCES, BUILD, INSTALL}.
+
+Use the options to define what directories you want to suppress and to set the list of products
+
+
+\subsection{Usage}
+\label{commands/clean:usage}\begin{itemize}
+\item {}
+Clean all previously created \emph{build} and \emph{install} directories (example application as \emph{SALOME\_xx}):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} take care, is long time to restore, sometimes}
+sat clean SALOME-xx --build --install
+\end{Verbatim}
+
+\item {}
+Clean previously created \emph{build} and \emph{install} directories, only for products with property \emph{is\_salome\_module}:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat clean SALOME-xxx --build --install \PYG{l+s+se}{\PYGZbs{}}
+ --properties is\PYGZus{}salome\PYGZus{}module:yes
+\end{Verbatim}
+
+\end{itemize}
+
+
+\subsection{Availables options}
+\label{commands/clean:availables-options}\begin{itemize}
+\item {}
+\textbf{--products} : Products to clean.
+
+\item {}
+\textbf{--properties} :
+
+\begin{DUlineblock}{0em}
+\item[] Filter the products by their properties.
+\item[] Syntax: \emph{--properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
+\end{DUlineblock}
+
+\item {}
+\textbf{--sources} : Clean the product source directories.
+
+\item {}
+\textbf{--build} : Clean the product build directories.
+
+\item {}
+\textbf{--install} : Clean the product install directories.
+
+\item {}
+\textbf{--all} : Clean the product source, build and install directories.
+
+\item {}
+\textbf{--sources\_without\_dev} :
+
+\begin{DUlineblock}{0em}
+\item[] Do not clean the products in development mode,
+\item[] (they could have \href{https://en.wikipedia.org/wiki/Version\_control}{VCS} (https://en.wikipedia.org/wiki/Version\_control) commits pending).
+\end{DUlineblock}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/clean:some-useful-configuration-pathes}
+No specific configuration.
+
+
+\section{Command package}
+\label{commands/package:svn}\label{commands/package:command-package}\label{commands/package::doc}
+
+\subsection{Description}
+\label{commands/package:description}
+The \textbf{package} command creates a \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) archive (usually a compressed \href{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar} (https://en.wikipedia.org/wiki/Tar\_(computing)) file .tgz).
+This tar file is used later to intall SALOME on other remote computer.
+
+Depending on the selected options, the archive includes sources and binaries
+of SALOME products and prerequisites.
+
+Usually utility \emph{salomeTools} is included in the archive.
+
+\begin{notice}{note}{Note:}
+By default the package includes the sources of prerequisites and products.
+To select a subset use the \emph{--without\_property} or \emph{--with\_vcs} options.
+\end{notice}
+
+
+\subsection{Usage}
+\label{commands/package:usage}\begin{itemize}
+\item {}
+Create a package for a product (example as \emph{SALOME\_xx}):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat package SALOME\_xx
+\end{Verbatim}
+
+This command will create an archive named \code{SALOME\_xx.tgz}
+in the working directory (\code{USER.workDir}).
+If the archive already exists, do nothing.
+
+\item {}
+Create a package with a specific name:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat package SALOME\_xx --name YourSpecificName
+\end{Verbatim}
+
+\end{itemize}
+
+\begin{notice}{note}{Note:}
+By default, the archive is created in the working directory of the user (\code{USER.workDir}).
+
+If the option \emph{--name} is used with a path (relative or absolute) it will be used.
+
+If the option \emph{--name} is not used and binaries (prerequisites and products)
+are included in the package, the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS} (https://en.wikipedia.org/wiki/Operating\_system) architecture
+will be appended to the name (example: \code{SALOME\_xx-CO7.tgz}).
+
+Examples:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\# Creates SALOME\_xx.tgz in \$USER.workDir
+sat package SALOME\_xx
+
+\# Creates SALOME\_xx\_\textless{}arch\textgreater{}.tgz in \$USER.workDir
+sat package SALOME\_xx --binaries
+
+\# Creates MySpecificName.tgz in \$USER.workDir
+sat package SALOME\_xx --name MySpecificName
+\end{Verbatim}
+\end{notice}
+\begin{itemize}
+\item {}
+Force the creation of the archive (if it already exists):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat package SALOME\_xx --force
+\end{Verbatim}
+
+\item {}
+Include the binaries in the archive (products and prerequisites):
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat package SALOME\_xx --binaries
+\end{Verbatim}
+
+This command will create an archive named \code{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}
+where \textless{}arch\textgreater{} is the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS} (https://en.wikipedia.org/wiki/Operating\_system) architecture of the machine.
+
+\item {}
+Do not delete Version Control System (\href{https://en.wikipedia.org/wiki/Version\_control}{VCS} (https://en.wikipedia.org/wiki/Version\_control)) informations from the configurations files of the embedded salomeTools:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat package SALOME\_xx --with\_vcs
+\end{Verbatim}
+
+The version control systems known by this option are \href{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS} (https://fr.wikipedia.org/wiki/Concurrent\_versions\_system), \href{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN} (https://en.wikipedia.org/wiki/Apache\_Subversion) and \href{https://git-scm.com}{Git} (https://git-scm.com).
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{commands/package:some-useful-configuration-pathes}
+No specific configuration.
+
+
+\section{Command generate}
+\label{commands/generate:svn}\label{commands/generate:command-generate}\label{commands/generate::doc}
+
+\subsection{Description}
+\label{commands/generate:description}
+The \textbf{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.
+
+\begin{notice}{note}{Note:}
+This command uses YACSGEN to generate the module. It needs to be specified with \emph{--yacsgen} option, or defined in the product or by the environment variable \code{\$YACSGEN\_ROOT\_DIR}.
+\end{notice}
+
+
+\subsection{Remarks}
+\label{commands/generate:remarks}\begin{itemize}
+\item {}
+This command will only apply on the CPP modules of the application, those who have both properties:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+cpp : "yes"
+generate : "yes"
+\end{Verbatim}
+
+\item {}
+The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
+
+\end{itemize}
+
+
+\subsection{Usage}
+\label{commands/generate:usage}\begin{itemize}
+\item {}
+Generate all the modules of a product:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat generate \textless{}application\textgreater{}
+\end{Verbatim}
+
+\item {}
+Generate only specific modules:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat generate \textless{}application\textgreater{} --products \textless{}list\_of\_products\textgreater{}
+\end{Verbatim}
+
+Remark: modules which don't have the \emph{generate} property are ignored.
+
+\item {}
+Use a specific version of YACSGEN:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+sat generate \textless{}application\textgreater{} --yacsgen \textless{}path\_to\_yacsgen\textgreater{}
+\end{Verbatim}
+
+\end{itemize}
+
+
+\chapter{Developer documentation}
+\label{index:developer-documentation}
+
+\section{Add a user custom command}
+\label{write_command:svn}\label{write_command:add-a-user-custom-command}\label{write_command::doc}
+
+\subsection{Introduction}
+\label{write_command:introduction}
+\begin{notice}{note}{Note:}
+This documentation is for \href{https://docs.python.org/2.7}{Python} (https://docs.python.org/2.7) developers.
+\end{notice}
+
+The salomeTools product provides a simple way to develop commands.
+The first thing to do is to add a file with \emph{.py} extension in the \code{commands} directory of salomeTools.
+
+Here are the basic requirements that must be followed in this file in order to add a command.
+
+
+\subsection{Basic requirements}
+\label{write_command:basic-requirements}
+By adding a file \emph{mycommand.py} in the \code{commands} directory, salomeTools will define a new command named \code{mycommand}.
+
+In \emph{mycommand.py}, there must be the following method:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+ \PYG{c}{\PYGZsh{} your algorithm ...}
+ \PYG{k}{pass}
+\end{Verbatim}
+
+In fact, at this point, the command will already be functional.
+But there are some useful services provided by salomeTools :
+\begin{itemize}
+\item {}
+You can give some options to your command:
+
+\end{itemize}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{import} \PYG{n+nn}{src}
+
+\PYG{c}{\PYGZsh{} Define all possible option for mycommand command : 'sat mycommand \textless{}options\textgreater{}'}
+\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{m}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{}
+ \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{}
+ \PYG{l+s}{'}\PYG{l+s}{My option changes the behavior of my command.}\PYG{l+s}{'}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+ \PYG{c}{\PYGZsh{} Parse the options}
+ \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+ \PYG{c}{\PYGZsh{} algorithm}
+\end{Verbatim}
+\begin{itemize}
+\item {}
+You can add a \emph{description} method that will display a message when the user will call the help:
+
+\end{itemize}
+
+\begin{Verbatim}[commandchars=\\\{\}]
+ \PYG{k+kn}{import} \PYG{n+nn}{src}
+
+ \PYG{c}{\PYGZsh{} Define all possible option for mycommand command : 'sat mycommand \textless{}options\textgreater{}'}
+ \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+ \PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{m}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{}
+ \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{}
+ \PYG{l+s}{'}\PYG{l+s}{My option changes the behavior of my command.}\PYG{l+s}{'}\PYG{p}{)}
+
+ \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
+ \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{The help of mycommand.}\PYG{l+s}{"}\PYG{p}{)}
+
+ \PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+ \PYG{c}{\PYGZsh{} Parse the options}
+ \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+ \PYG{c}{\PYGZsh{} algorithm}
+\end{Verbatim}
+
+
+\subsection{HowTo access salomeTools config and other commands}
+\label{write_command:howto-access-salometools-config-and-other-commands}
+The \emph{runner} variable is an python instance of \emph{Sat} class.
+It gives access to \emph{runner.cfg} which is the data model defined from all
+\emph{configuration pyconf files} of salomeTools
+For example, \emph{runner.cfg.APPLICATION.workdir}
+contains the root directory of the current application.
+
+The \emph{runner} variable gives also access to other commands of salomeTools:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} as CLI\PYGZus{} 'sat prepare ...'}
+\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)}
+\end{Verbatim}
+
+
+\subsection{HowTo logger}
+\label{write_command:howto-logger}
+The logger variable is an instance of the Logger class.
+It gives access to the write method.
+
+When this method is called, the message passed as parameter
+will be displayed in the terminal and written in an xml log file.
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{My message}\PYG{l+s}{"}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{)} \PYG{c}{\PYGZsh{} 3 as default}
+\end{Verbatim}
+
+The second argument defines the level of verbosity
+that is wanted for this message.
+It has to be between 1 and 5 (the most verbose level).
+
+
+\subsection{HELLO example}
+\label{write_command:hello-example}
+Here is a \emph{hello} command, file \emph{commands/hello.py}:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{import} \PYG{n+nn}{src}
+
+\PYG{l+s+sd}{"""}
+\PYG{l+s+sd}{hello.py}
+\PYG{l+s+sd}{Define all possible options for hello command:}
+\PYG{l+s+sd}{sat hello \textless{}options\textgreater{}}
+\PYG{l+s+sd}{"""}
+
+\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{f}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{french}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{french}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{"}\PYG{l+s}{french set hello message in french.}\PYG{l+s}{"}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
+ \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{The help of hello.}\PYG{l+s}{"}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+ \PYG{c}{\PYGZsh{} Parse the options}
+ \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+ \PYG{c}{\PYGZsh{} algorithm}
+ \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:}
+ \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s}{'}\PYG{p}{)}
+ \PYG{k}{else}\PYG{p}{:}
+ \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s}{'}\PYG{p}{)}
+\end{Verbatim}
+
+A first call of hello:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} Get the help of hello:}
+./sat --help hello
+
+\PYG{c}{\PYGZsh{} To get bonjour}
+./sat hello --french
+Bonjour tout le monde!
+
+\PYG{c}{\PYGZsh{} To get hello}
+./sat hello
+HELLO! WORLD!
+
+\PYG{c}{\PYGZsh{} To get the log}
+./sat log
+\end{Verbatim}
+
+
+\chapter{Code documentation}
+\label{index:code-documentation}
+
+\section{src}
+\label{commands/apidoc/modules:src}\label{commands/apidoc/modules::doc}
+
+\subsection{src Package}
+\label{commands/apidoc/src::doc}\label{commands/apidoc/src:src-package}
+
+\subsubsection{\texttt{src} Package}
+\label{commands/apidoc/src:id1}\phantomsection\label{commands/apidoc/src:module-src.__init__}\index{src.\_\_init\_\_ (module)}
+initial imports and utilities methods for salomeTools
+\index{Path (class in src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path}\pysiglinewithargsret{\strong{class }\code{src.\_\_init\_\_.}\bfcode{Path}}{\emph{path}}{}~\index{base() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.base}\pysiglinewithargsret{\bfcode{base}}{}{}
+\end{fulllineitems}
+
+\index{chmod() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.chmod}\pysiglinewithargsret{\bfcode{chmod}}{\emph{mode}}{}
+\end{fulllineitems}
+
+\index{copy() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.copy}\pysiglinewithargsret{\bfcode{copy}}{\emph{path}, \emph{smart=False}}{}
+\end{fulllineitems}
+
+\index{copydir() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.copydir}\pysiglinewithargsret{\bfcode{copydir}}{\emph{dst}, \emph{smart=False}}{}
+\end{fulllineitems}
+
+\index{copyfile() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.copyfile}\pysiglinewithargsret{\bfcode{copyfile}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{copylink() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.copylink}\pysiglinewithargsret{\bfcode{copylink}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{dir() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.dir}\pysiglinewithargsret{\bfcode{dir}}{}{}
+\end{fulllineitems}
+
+\index{exists() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.exists}\pysiglinewithargsret{\bfcode{exists}}{}{}
+\end{fulllineitems}
+
+\index{isdir() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.isdir}\pysiglinewithargsret{\bfcode{isdir}}{}{}
+\end{fulllineitems}
+
+\index{isfile() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.isfile}\pysiglinewithargsret{\bfcode{isfile}}{}{}
+\end{fulllineitems}
+
+\index{islink() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.islink}\pysiglinewithargsret{\bfcode{islink}}{}{}
+\end{fulllineitems}
+
+\index{list() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.list}\pysiglinewithargsret{\bfcode{list}}{}{}
+\end{fulllineitems}
+
+\index{make() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.make}\pysiglinewithargsret{\bfcode{make}}{\emph{mode=None}}{}
+\end{fulllineitems}
+
+\index{readlink() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.readlink}\pysiglinewithargsret{\bfcode{readlink}}{}{}
+\end{fulllineitems}
+
+\index{rm() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.rm}\pysiglinewithargsret{\bfcode{rm}}{}{}
+\end{fulllineitems}
+
+\index{smartcopy() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.smartcopy}\pysiglinewithargsret{\bfcode{smartcopy}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{symlink() (src.\_\_init\_\_.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.Path.symlink}\pysiglinewithargsret{\bfcode{symlink}}{\emph{path}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{SatException}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.SatException}\pysigline{\strong{exception }\code{src.\_\_init\_\_.}\bfcode{SatException}}
+Bases: \code{exceptions.Exception}
+
+rename Exception Class
+
+\end{fulllineitems}
+
+\index{activate\_mesa\_property() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.activate_mesa_property}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{activate\_mesa\_property}}{\emph{config}}{}
+Add mesa property into application properties
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{config}) -- The global configuration. It must have an application!
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_config\_has\_application() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.check_config_has_application}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{check\_config\_has\_application}}{\emph{config}, \emph{details=None}}{}
+check that the config has the key APPLICATION. Else raise an exception.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_config\_has\_profile() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.check_config_has_profile}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{check\_config\_has\_profile}}{\emph{config}, \emph{details=None}}{}
+check that the config has the key APPLICATION.profile.
+else, raise an exception.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{config\_has\_application() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.config_has_application}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{config\_has\_application}}{\emph{config}}{}
+\end{fulllineitems}
+
+\index{deepcopy\_list() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.deepcopy_list}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{deepcopy\_list}}{\emph{input\_list}}{}
+Do a deep copy of a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{List} (\emph{input\_list}) -- The list to copy
+
+\item[{Returns}] \leavevmode
+The copy of the list
+
+\item[{Return type}] \leavevmode
+List
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{ensure\_path\_exists() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.ensure_path_exists}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{ensure\_path\_exists}}{\emph{p}}{}
+Create a path if not existing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{p}) -- The path.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_file\_in\_lpath() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.find_file_in_lpath}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{find\_file\_in\_lpath}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir='`}}{}
+Find in all the directories in lpath list the file that has the same name
+as file\_name.
+If it is found
+then return the full path of the file
+else return False.
+
+The additional\_dir (optional) is the name of the directory to add to all
+paths in lpath.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{additional\_dir}) -- The file name to search
+
+\item {}
+\textbf{List} (\emph{lpath}) -- The list of directories where to search
+
+\item {}
+\textbf{str} -- The name of the additional directory
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the full path of the file or False if not found
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_base\_path() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_base_path}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_base\_path}}{\emph{config}}{}
+Returns the path of the products base.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{config}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The path of the products base.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_cfg\_param() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_cfg_param}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_cfg\_param}}{\emph{config}, \emph{param\_name}, \emph{default}}{}
+eearch for param\_name value in config.
+if param\_name is not in config
+then return default,
+else return the found value
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config.
+
+\item {}
+\textbf{str} (\emph{default}) -- the name of the parameter to get the value
+
+\item {}
+\textbf{str} -- The value to return if param\_name is not in config
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+see initial description of the function
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_launcher\_name() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_launcher_name}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_launcher\_name}}{\emph{config}}{}
+Returns the name of salome launcher.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{config}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The name of salome launcher.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_log\_path() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_log_path}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_log\_path}}{\emph{config}}{}
+Returns the path of the logs.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{config}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The path of the logs.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_property_in_product_cfg}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_property\_in\_product\_cfg}}{\emph{product\_cfg}, \emph{pprty}}{}
+\end{fulllineitems}
+
+\index{get\_salome\_version() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_salome_version}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_salome\_version}}{\emph{config}}{}
+\end{fulllineitems}
+
+\index{get\_tmp\_filename() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.get_tmp_filename}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_tmp\_filename}}{\emph{cfg}, \emph{name}}{}
+\end{fulllineitems}
+
+\index{handleRemoveReadonly() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.handleRemoveReadonly}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{handleRemoveReadonly}}{\emph{func}, \emph{path}, \emph{exc}}{}
+\end{fulllineitems}
+
+\index{merge\_dicts() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.merge_dicts}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{merge\_dicts}}{\emph{*dict\_args}}{}
+Given any number of dicts, shallow copy and merge into a new dict,
+precedence goes to key value pairs in latter dicts.
+
+\end{fulllineitems}
+
+\index{only\_numbers() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.only_numbers}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{only\_numbers}}{\emph{str\_num}}{}
+\end{fulllineitems}
+
+\index{parse\_date() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.parse_date}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{parse\_date}}{\emph{date}}{}
+Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{date}) -- The date to transform
+
+\item[{Returns}] \leavevmode
+The date in the new format
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_info() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.print_info}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{print\_info}}{\emph{logger}, \emph{info}}{}
+Prints the tuples that are in info variable in a formatted way.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logging instance to use for the prints.
+
+\item {}
+\textbf{list} (\emph{info}) -- The list of tuples to display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.read_config_from_a_file}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{read\_config\_from\_a\_file}}{\emph{filePath}}{}
+\end{fulllineitems}
+
+\index{remove\_item\_from\_list() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.remove_item_from_list}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{remove\_item\_from\_list}}{\emph{input\_list}, \emph{item}}{}
+Remove all occurences of item from input\_list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{List} (\emph{input\_list}) -- The list to modify
+
+\item[{Returns}] \leavevmode
+The without any item
+
+\item[{Return type}] \leavevmode
+List
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{replace\_in\_file() (in module src.\_\_init\_\_)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.__init__.replace_in_file}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{replace\_in\_file}}{\emph{filein}, \emph{strin}, \emph{strout}}{}
+Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{ElementTree} Module}
+\label{commands/apidoc/src:elementtree-module}\label{commands/apidoc/src:module-src.ElementTree}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.Comment}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{Comment}}{\emph{text=None}}{}
+\end{fulllineitems}
+
+\index{dump() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.dump}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{dump}}{\emph{elem}}{}
+\end{fulllineitems}
+
+\index{Element() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.Element}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{Element}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\end{fulllineitems}
+
+\index{ElementTree (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{ElementTree}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.find}\pysiglinewithargsret{\bfcode{find}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{findall() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findall}\pysiglinewithargsret{\bfcode{findall}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{findtext() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findtext}\pysiglinewithargsret{\bfcode{findtext}}{\emph{path}, \emph{default=None}}{}
+\end{fulllineitems}
+
+\index{getiterator() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}\pysiglinewithargsret{\bfcode{getiterator}}{\emph{tag=None}}{}
+\end{fulllineitems}
+
+\index{getroot() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getroot}\pysiglinewithargsret{\bfcode{getroot}}{}{}
+\end{fulllineitems}
+
+\index{parse() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.parse}\pysiglinewithargsret{\bfcode{parse}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
+
+\index{write() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.write}\pysiglinewithargsret{\bfcode{write}}{\emph{file}, \emph{encoding='us-ascii'}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{fromstring() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.fromstring}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{fromstring}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{iselement() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iselement}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{iselement}}{\emph{element}}{}
+\end{fulllineitems}
+
+\index{iterparse (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{iterparse}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse.next}\pysiglinewithargsret{\bfcode{next}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{parse() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.parse}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{parse}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
+
+\index{PI() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.PI}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{PI}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
+
+\index{ProcessingInstruction() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ProcessingInstruction}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{ProcessingInstruction}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
+
+\index{QName (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.QName}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{QName}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
+\end{fulllineitems}
+
+\index{SubElement() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.SubElement}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{SubElement}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\end{fulllineitems}
+
+\index{tostring() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.tostring}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{tostring}}{\emph{element}, \emph{encoding=None}}{}
+\end{fulllineitems}
+
+\index{TreeBuilder (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{TreeBuilder}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.close}\pysiglinewithargsret{\bfcode{close}}{}{}
+\end{fulllineitems}
+
+\index{data() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.data}\pysiglinewithargsret{\bfcode{data}}{\emph{data}}{}
+\end{fulllineitems}
+
+\index{end() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.end}\pysiglinewithargsret{\bfcode{end}}{\emph{tag}}{}
+\end{fulllineitems}
+
+\index{start() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.start}\pysiglinewithargsret{\bfcode{start}}{\emph{tag}, \emph{attrs}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{XML() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XML}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{XML}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{XMLTreeBuilder (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{XMLTreeBuilder}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}\pysiglinewithargsret{\bfcode{close}}{}{}
+\end{fulllineitems}
+
+\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}\pysiglinewithargsret{\bfcode{doctype}}{\emph{name}, \emph{pubid}, \emph{system}}{}
+\end{fulllineitems}
+
+\index{feed() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}\pysiglinewithargsret{\bfcode{feed}}{\emph{data}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{architecture} Module}
+\label{commands/apidoc/src:architecture-module}\label{commands/apidoc/src:module-src.architecture}\index{src.architecture (module)}
+In this file : all the stuff that can change with the architecture
+on which SAT is running
+\index{get\_distrib\_version() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.get_distrib_version}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_distrib\_version}}{\emph{distrib}, \emph{codes}}{}
+Gets the version of the distribution
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{distrib}) -- The distribution on which the version will be found.
+
+\item {}
+\textbf{L\{Mapping\}} (\emph{codes}) -- The map containing distribution correlation table.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The version of the distribution on which salomeTools is running,
+regarding the distribution correlation table contained in codes
+variable.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_distribution() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.get_distribution}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_distribution}}{\emph{codes}}{}
+Gets the code for the distribution
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{L\{Mapping\}} (\emph{codes}) -- The map containing distribution correlation table.
+
+\item[{Returns}] \leavevmode
+The distribution on which salomeTools is running, regarding the
+distribution correlation table contained in codes variable.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_nb\_proc() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.get_nb_proc}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_nb\_proc}}{}{}
+Gets the number of processors of the machine
+on which salomeTools is running.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+the number of processors.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_python\_version() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.get_python_version}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_python\_version}}{}{}
+Gets the version of the running python.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+the version of the running python.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_user() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.get_user}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_user}}{}{}
+method that gets the username that launched sat
+\begin{quote}\begin{description}
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_windows() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.architecture.is_windows}\pysiglinewithargsret{\code{src.architecture.}\bfcode{is\_windows}}{}{}
+method that checks windows OS
+\begin{quote}\begin{description}
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{compilation} Module}
+\label{commands/apidoc/src:module-src.compilation}\label{commands/apidoc/src:compilation-module}\index{src.compilation (module)}\index{Builder (class in src.compilation)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder}\pysiglinewithargsret{\strong{class }\code{src.compilation.}\bfcode{Builder}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=\textless{}src.options.OptResult object at 0x245afd0\textgreater{}}, \emph{check\_src=True}}{}
+Class to handle all construction steps, like cmake, configure, make, ...
+\index{build\_configure() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.build_configure}\pysiglinewithargsret{\bfcode{build\_configure}}{\emph{options='`}}{}
+\end{fulllineitems}
+
+\index{check() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.check}\pysiglinewithargsret{\bfcode{check}}{\emph{command='`}}{}
+\end{fulllineitems}
+
+\index{cmake() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.cmake}\pysiglinewithargsret{\bfcode{cmake}}{\emph{options='`}}{}
+\end{fulllineitems}
+
+\index{complete\_environment() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.complete_environment}\pysiglinewithargsret{\bfcode{complete\_environment}}{\emph{make\_options}}{}
+\end{fulllineitems}
+
+\index{configure() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.configure}\pysiglinewithargsret{\bfcode{configure}}{\emph{options='`}}{}
+\end{fulllineitems}
+
+\index{do\_batch\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}\pysiglinewithargsret{\bfcode{do\_batch\_script\_build}}{\emph{script}, \emph{nb\_proc}}{}
+\end{fulllineitems}
+
+\index{do\_default\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_default_build}\pysiglinewithargsret{\bfcode{do\_default\_build}}{\emph{build\_conf\_options='`}, \emph{configure\_options='`}, \emph{show\_warning=True}}{}
+\end{fulllineitems}
+
+\index{do\_python\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_python_script_build}\pysiglinewithargsret{\bfcode{do\_python\_script\_build}}{\emph{script}, \emph{nb\_proc}}{}
+\end{fulllineitems}
+
+\index{do\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_script_build}\pysiglinewithargsret{\bfcode{do\_script\_build}}{\emph{script}, \emph{number\_of\_proc=0}}{}
+\end{fulllineitems}
+
+\index{hack\_libtool() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.hack_libtool}\pysiglinewithargsret{\bfcode{hack\_libtool}}{}{}
+\end{fulllineitems}
+
+\index{install() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.install}\pysiglinewithargsret{\bfcode{install}}{}{}
+\end{fulllineitems}
+
+\index{log() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log}\pysiglinewithargsret{\bfcode{log}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
+\end{fulllineitems}
+
+\index{log\_command() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log_command}\pysiglinewithargsret{\bfcode{log\_command}}{\emph{command}}{}
+\end{fulllineitems}
+
+\index{make() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.make}\pysiglinewithargsret{\bfcode{make}}{\emph{nb\_proc}, \emph{make\_opt='`}}{}
+\end{fulllineitems}
+
+\index{prepare() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.prepare}\pysiglinewithargsret{\bfcode{prepare}}{}{}
+\end{fulllineitems}
+
+\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}\pysiglinewithargsret{\bfcode{put\_txt\_log\_in\_appli\_log\_dir}}{\emph{file\_name}}{}
+Put the txt log (that contain the system logs, like make command
+output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Str} (\emph{file\_name}) -- the name of the file to write
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{wmake() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.wmake}\pysiglinewithargsret{\bfcode{wmake}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{debug} Module}
+\label{commands/apidoc/src:module-src.debug}\label{commands/apidoc/src:debug-module}\index{src.debug (module)}
+This file assume DEBUG functionalities use
+\begin{itemize}
+\item {}
+print debug messages in sys.stderr for salomeTools
+
+\item {}
+show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config), and python dict/list etc. (as `aVariable')
+
+\end{itemize}
+
+WARNING: obviously supposedly show messages in SAT development phase, not production
+
+usage:
+\textgreater{}\textgreater{} import debug as DBG
+\textgreater{}\textgreater{} DBG.write(``aTitle'', aVariable) \# not shown in production
+\textgreater{}\textgreater{} DBG.write(``aTitle'', aVariable, True) \# unconditionaly shown (as show=True)
+
+to set show message as development phase:
+\textgreater{}\textgreater{} DBG.push\_debug(True)
+
+to set no show message as production phase:
+\textgreater{}\textgreater{} DBG.push\_debug(False)
+
+to set show message temporary as development phase, only in a method:
+\textgreater{}\textgreater{} def aMethodToDebug(...):
+\textgreater{}\textgreater{} DBG.push\_debug(True) \#force show as appended status
+\textgreater{}\textgreater{} etc. method code with some DBG.write()
+\textgreater{}\textgreater{} DBG.pop\_debug() \#restore previous status (show or not show)
+\textgreater{}\textgreater{} return
+
+to set a message for future fix, as temporary problem to not forget:
+DBG.tofix(``aTitle'', aVariable, True/False) \#True/False in production shown, or not
+
+in command line interface you could redirect stderr to file `myDebug.log':
+\textgreater{}\textgreater{} sat compile ... 2\textgreater{} myDebug.log \# only stderr
+\textgreater{}\textgreater{} sat compile ... \&\textgreater{} myDebug.log \# stdout and stderr
+\index{InStream (class in src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.InStream}\pysiglinewithargsret{\strong{class }\code{src.debug.}\bfcode{InStream}}{\emph{buf='`}}{}
+Bases: \code{StringIO.StringIO}
+
+utility class for pyconf.Config input iostream
+
+\end{fulllineitems}
+
+\index{OutStream (class in src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.OutStream}\pysiglinewithargsret{\strong{class }\code{src.debug.}\bfcode{OutStream}}{\emph{buf='`}}{}
+Bases: \code{StringIO.StringIO}
+
+utility class for pyconf.Config output iostream
+\index{close() (src.debug.OutStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.OutStream.close}\pysiglinewithargsret{\bfcode{close}}{}{}
+because Config.\_\_save\_\_ calls close() stream as file
+keep value before lost as self.value
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{getLocalEnv() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.getLocalEnv}\pysiglinewithargsret{\code{src.debug.}\bfcode{getLocalEnv}}{}{}
+get string for environment variables representation
+
+\end{fulllineitems}
+
+\index{getStrConfigDbg() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigDbg}\pysiglinewithargsret{\code{src.debug.}\bfcode{getStrConfigDbg}}{\emph{config}}{}
+set string as saveConfigDbg,
+as (path expression evaluation) for debug
+
+\end{fulllineitems}
+
+\index{getStrConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigStd}\pysiglinewithargsret{\code{src.debug.}\bfcode{getStrConfigStd}}{\emph{config}}{}
+set string as saveConfigStd, as file .pyconf
+
+\end{fulllineitems}
+
+\index{indent() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.indent}\pysiglinewithargsret{\code{src.debug.}\bfcode{indent}}{\emph{text}, \emph{amount=2}, \emph{ch=' `}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{pop\_debug() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.pop_debug}\pysiglinewithargsret{\code{src.debug.}\bfcode{pop\_debug}}{}{}
+restore previous debug outputs status
+
+\end{fulllineitems}
+
+\index{push\_debug() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.push_debug}\pysiglinewithargsret{\code{src.debug.}\bfcode{push\_debug}}{\emph{aBool}}{}
+set debug outputs activated, or not
+
+\end{fulllineitems}
+
+\index{saveConfigDbg() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.saveConfigDbg}\pysiglinewithargsret{\code{src.debug.}\bfcode{saveConfigDbg}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path='`}}{}
+pyconf returns multilines (path expression evaluation) for debug
+
+\end{fulllineitems}
+
+\index{saveConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.saveConfigStd}\pysiglinewithargsret{\code{src.debug.}\bfcode{saveConfigStd}}{\emph{config}, \emph{aStream}}{}
+returns as file .pyconf
+
+\end{fulllineitems}
+
+\index{tofix() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.tofix}\pysiglinewithargsret{\code{src.debug.}\bfcode{tofix}}{\emph{title}, \emph{var='`}, \emph{force=None}}{}
+write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
+use this only if no logger accessible for classic
+logger.warning(message) or logger.debug(message)
+
+\end{fulllineitems}
+
+\index{write() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.write}\pysiglinewithargsret{\code{src.debug.}\bfcode{write}}{\emph{title}, \emph{var='`}, \emph{force=None}, \emph{fmt='\textbackslash{}n\#\#\#\# DEBUG: \%s:\textbackslash{}n\%s\textbackslash{}n'}}{}
+write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{environment} Module}
+\label{commands/apidoc/src:environment-module}\label{commands/apidoc/src:module-src.environment}\index{src.environment (module)}\index{Environ (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{Environ}}{\emph{environ=None}}{}
+Class to manage the environment context
+\index{append() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str} -- the value to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{FileEnvWriter (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{FileEnvWriter}}{\emph{config}, \emph{logger}, \emph{out\_dir}, \emph{src\_root}, \emph{env\_info=None}}{}
+Class to dump the environment to a file.
+\index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}\pysiglinewithargsret{\bfcode{write\_cfgForPy\_file}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{}
+Append to current opened aFile a cfgForPy
+environment (SALOME python launcher).
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{for\_package}) -- the file path
+
+\item {}
+\textbf{dict} (\emph{additional\_env}) -- a dictionary of additional variables
+to add to the environment
+
+\item {}
+\textbf{str} -- If not None, produce a relative environment
+designed for a package.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_env\_file() (src.environment.FileEnvWriter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}\pysiglinewithargsret{\bfcode{write\_env\_file}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{}
+Create an environment file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{shell}) -- the file path
+
+\item {}
+\textbf{bool} (\emph{forBuild}) -- if true, the build environment
+
+\item {}
+\textbf{str} -- the type of file wanted (.sh, .bat)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path to the generated file
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{SalomeEnviron (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{SalomeEnviron}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{}
+Class to manage the environment of SALOME.
+\index{add\_comment() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{}
+Add a commentary to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{comment}) -- the commentary to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{nb\_line}}{}
+Add empty lines to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{int} (\emph{nb\_line}) -- the number of empty lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{}
+Add a warning to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{warning}) -- the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str} -- the value to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{dump() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.dump}\pysiglinewithargsret{\bfcode{dump}}{\emph{out}}{}
+Write the environment to out
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{file} (\emph{out}) -- the stream where to write the environment
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_names() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get_names}\pysiglinewithargsret{\bfcode{get\_names}}{\emph{lProducts}}{}
+Get the products name to add in SALOME\_MODULES environment variable
+It is the name of the product, except in the case where the is a
+component name. And it has to be in SALOME\_MODULES variable only
+if the product has the property has\_salome\_hui = ``yes''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{list} (\emph{lProducts}) -- List of products to potentially add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}\pysiglinewithargsret{\bfcode{load\_cfg\_environment}}{\emph{cfg\_env}}{}
+Loads environment defined in cfg\_env
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{cfg\_env}) -- A config containing an environment
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_env\_script() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}\pysiglinewithargsret{\bfcode{run\_env\_script}}{\emph{product\_info}, \emph{logger=None}, \emph{native=False}}{}
+Runs an environment script.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The product description
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\item {}
+\textbf{Boolean} (\emph{native}) -- if True load set\_native\_env instead of set\_env
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}\pysiglinewithargsret{\bfcode{run\_simple\_env\_script}}{\emph{script\_path}, \emph{logger=None}}{}
+Runs an environment script. Same as run\_env\_script, but with a
+script path as parameter.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{script\_path}) -- a path to an environment script
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_a\_product() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}\pysiglinewithargsret{\bfcode{set\_a\_product}}{\emph{product}, \emph{logger}}{}
+Sets the environment of a product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{product}) -- The product name
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_application\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}\pysiglinewithargsret{\bfcode{set\_application\_env}}{\emph{logger}}{}
+Sets the environment defined in the APPLICATION file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}\pysiglinewithargsret{\bfcode{set\_cpp\_env}}{\emph{product\_info}}{}
+Sets the generic environment for a SALOME cpp product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The product description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}\pysiglinewithargsret{\bfcode{set\_full\_environ}}{\emph{logger}, \emph{env\_info}}{}
+Sets the full environment for products
+specified in env\_info dictionary.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\item {}
+\textbf{list} (\emph{env\_info}) -- the list of products
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_products() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_products}\pysiglinewithargsret{\bfcode{set\_products}}{\emph{logger}, \emph{src\_root=None}}{}
+Sets the environment for all the products.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\item {}
+\textbf{src} (\emph{src\_root}) -- the application working directory
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}\pysiglinewithargsret{\bfcode{set\_python\_libdirs}}{}{}
+Set some generic variables for python library paths
+
+\end{fulllineitems}
+
+\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}\pysiglinewithargsret{\bfcode{set\_salome\_generic\_product\_env}}{\emph{pi}}{}
+Sets the generic environment for a SALOME product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{pi}) -- The product description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}\pysiglinewithargsret{\bfcode{set\_salome\_minimal\_product\_env}}{\emph{product\_info}, \emph{logger}}{}
+Sets the minimal environment for a SALOME product.
+xxx\_ROOT\_DIR and xxx\_SRC\_DIR
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The product description
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Shell (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Shell}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{Shell}}{\emph{name}, \emph{extension}}{}
+Definition of a Shell.
+
+\end{fulllineitems}
+
+\index{load\_environment() (in module src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.load_environment}\pysiglinewithargsret{\code{src.environment.}\bfcode{load\_environment}}{\emph{config}, \emph{build}, \emph{logger}}{}
+Loads the environment (used to run the tests, for example).
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{config}) -- the global config
+
+\item {}
+\textbf{bool} (\emph{build}) -- build environement if True
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{fileEnviron} Module}
+\label{commands/apidoc/src:fileenviron-module}\label{commands/apidoc/src:module-src.fileEnviron}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{BashFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}}
+
+Class for bash shell.
+\index{command\_value() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{BatFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{BatFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}}
+
+for Windows batch shell.
+\index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{}
+Add a comment in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{comment}) -- the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+In the particular windows case, do nothing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ContextFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{ContextFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}}
+
+Class for a salome context configuration file.
+\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{}
+Add a comment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{text}) -- the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{text}) -- the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str} -- the value to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{FileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{FileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: \code{object}
+
+Base class for shell environment
+\index{add\_comment() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{}
+Add a comment in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{comment}) -- the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{}
+Add a ``echo'' in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{text}) -- the text to echo
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{}
+Add some empty lines in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{int} (\emph{number}) -- the number of lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{}
+Add a warning ``echo'' in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{warning}) -- the text to echo
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str} -- the value to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable `key' to value `value'
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{LauncherFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{LauncherFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Class to generate a launcher file script
+(in python syntax) SalomeContext API
+\index{add() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}\pysiglinewithargsret{\bfcode{add}}{\emph{key}, \emph{value}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{}
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{}
+Add a comment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{text}) -- the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{}
+Add some empty lines in the launcher file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{int} (\emph{number}) -- the number of lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{text}) -- the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to append
+
+\item {}
+\textbf{str} -- the value to append to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}\pysiglinewithargsret{\bfcode{change\_to\_launcher}}{\emph{value}}{}
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command ``command''
+and put it in the environment variable key.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command}) -- the environment variable
+
+\item {}
+\textbf{str} -- the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+In the particular launcher case, do nothing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{bool} (\emph{required}) -- Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{key}) -- the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{sep}) -- the environment variable to prepend
+
+\item {}
+\textbf{str} -- the value to prepend to key
+
+\item {}
+\textbf{str} -- the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{}
+Set the environment variable ``key'' to value ``value''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{value}) -- the environment variable to set
+
+\item {}
+\textbf{str} -- the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ScreenEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{ScreenEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}}
+\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{}
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{}
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{}
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{}
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{name}}{}
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{name}}{}
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
+
+\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}\pysiglinewithargsret{\bfcode{run\_env\_script}}{\emph{module}, \emph{script}}{}
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{name}, \emph{value}}{}
+\end{fulllineitems}
+
+\index{write() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}\pysiglinewithargsret{\bfcode{write}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_file\_environ() (in module src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.get_file_environ}\pysiglinewithargsret{\code{src.fileEnviron.}\bfcode{get\_file\_environ}}{\emph{output}, \emph{shell}, \emph{environ=None}}{}
+Instantiate correct FileEnvironment sub-class.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{file} (\emph{output}) -- the output file stream.
+
+\item {}
+\textbf{str} (\emph{shell}) -- the type of shell syntax to use.
+
+\item {}
+\textbf{dict} (\emph{environ}) -- a potential additional environment.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{special\_path\_separator() (in module src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.special_path_separator}\pysiglinewithargsret{\code{src.fileEnviron.}\bfcode{special\_path\_separator}}{\emph{name}}{}
+TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need
+some exotic path separator.
+This function gives the separator regarding the name of the variable
+to append or prepend.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{name}) -- The name of the variable to find the separator
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{fork} Module}
+\label{commands/apidoc/src:fork-module}\label{commands/apidoc/src:module-src.fork}\index{src.fork (module)}\index{batch() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.batch}\pysiglinewithargsret{\code{src.fork.}\bfcode{batch}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args=}\optional{}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
+\end{fulllineitems}
+
+\index{batch\_salome() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.batch_salome}\pysiglinewithargsret{\code{src.fork.}\bfcode{batch\_salome}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args}, \emph{getTmpDir}, \emph{pendant='SALOME\_Session\_Server'}, \emph{fin='killSalome.py'}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}, \emph{delaiapp=0}}{}
+\end{fulllineitems}
+
+\index{launch\_command() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.launch_command}\pysiglinewithargsret{\code{src.fork.}\bfcode{launch\_command}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args=}\optional{}, \emph{log=None}}{}
+\end{fulllineitems}
+
+\index{show\_progress() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.show_progress}\pysiglinewithargsret{\code{src.fork.}\bfcode{show\_progress}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss='`}}{}
+shortcut function to display the progression
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logging instance
+
+\item {}
+\textbf{int} (\emph{delai}) -- the number to display
+
+\item {}
+\textbf{int} -- the number max
+
+\item {}
+\textbf{str} (\emph{ss}) -- the string to display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_back() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.write_back}\pysiglinewithargsret{\code{src.fork.}\bfcode{write\_back}}{\emph{logger}, \emph{message}, \emph{level}}{}
+shortcut function to write at the begin of the line
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logging instance
+
+\item {}
+\textbf{str} (\emph{message}) -- the text to display
+
+\item {}
+\textbf{int} (\emph{level}) -- the level of verbosity
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{logger} Module}
+\label{commands/apidoc/src:logger-module}\label{commands/apidoc/src:module-src.logger}\index{src.logger (module)}
+Implements the classes and method relative to the logging
+\index{Logger (class in src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger}\pysiglinewithargsret{\strong{class }\code{src.logger.}\bfcode{Logger}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
+Bases: \code{object}
+
+Class to handle log mechanism.
+\index{add\_link() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.add_link}\pysiglinewithargsret{\bfcode{add\_link}}{\emph{log\_file\_name}, \emph{command\_name}, \emph{command\_res}, \emph{full\_launched\_command}}{}
+Add a link to another log file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{command\_res}) -- The file name of the link.
+
+\item {}
+\textbf{str} -- The name of the command linked.
+
+\item {}
+\textbf{str} -- The result of the command linked. ``0'' or ``1''
+
+\end{itemize}
+
+\item[{Parma full\_launched\_command str}] \leavevmode
+The full lanch command
+(``sat command ...'')
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{end\_write() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.end_write}\pysiglinewithargsret{\bfcode{end\_write}}{\emph{attribute}}{}
+Called just after command end: Put all fields
+corresponding to the command end context (time).
+Write the log xml file on the hard drive.
+And display the command to launch to get the log
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{dict} (\emph{attribute}) -- the attribute to add to the node ``Site''.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{error() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.error}\pysiglinewithargsret{\bfcode{error}}{\emph{message}}{}
+Print an error.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{message}) -- The message to print.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{flush() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.flush}\pysiglinewithargsret{\bfcode{flush}}{}{}
+Flush terminal
+
+\end{fulllineitems}
+
+\index{put\_initial\_xml\_fields() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}\pysiglinewithargsret{\bfcode{put\_initial\_xml\_fields}}{}{}
+Called at class initialization: Put all fields
+corresponding to the command context (user, time, ...)
+
+\end{fulllineitems}
+
+\index{write() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.Logger.write}\pysiglinewithargsret{\bfcode{write}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{}
+function used in the commands
+to print in the terminal and the log file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{message}) -- The message to print.
+
+\item {}
+\textbf{int} (\emph{level}) -- The output level corresponding
+to the message 0 \textless{} level \textless{} 6.
+
+\item {}
+\textbf{boolean} (\emph{screenOnly}) -- if True, do not write in log file.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{date\_to\_datetime() (in module src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.date_to_datetime}\pysiglinewithargsret{\code{src.logger.}\bfcode{date\_to\_datetime}}{\emph{date}}{}
+From a string date in format YYYYMMDD\_HHMMSS
+returns list year, mon, day, hour, minutes, seconds
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{date}) -- The date in format YYYYMMDD\_HHMMSS
+
+\item[{Returns}] \leavevmode
+the same date and time in separate variables.
+
+\item[{Return type}] \leavevmode
+(str,str,str,str,str,str)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{list\_log\_file() (in module src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.list_log_file}\pysiglinewithargsret{\code{src.logger.}\bfcode{list\_log\_file}}{\emph{dirPath}, \emph{expression}}{}
+Find all files corresponding to expression in dirPath
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{expression}) -- the directory where to search the files
+
+\item {}
+\textbf{str} -- the regular expression of files to find
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of files path and informations about it
+
+\item[{Return type}] \leavevmode
+list
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_command\_log() (in module src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.show_command_log}\pysiglinewithargsret{\code{src.logger.}\bfcode{show\_command\_log}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{}
+Used in updateHatXml.
+Determine if the log xml file logFilePath
+has to be shown or not in the hat log.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{application}) -- the path to the command xml log file
+
+\item {}
+\textbf{str} -- the command of the log file
+
+\item {}
+\textbf{str} -- the application passed as parameter
+to the salomeTools command
+
+\item {}
+\textbf{list} (\emph{notShownCommands}) -- the list of commands
+that are not shown by default
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True if cmd is not in notShownCommands and the application
+in the log file corresponds to application
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{timedelta\_total\_seconds() (in module src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.timedelta_total_seconds}\pysiglinewithargsret{\code{src.logger.}\bfcode{timedelta\_total\_seconds}}{\emph{timedelta}}{}
+Replace total\_seconds from datetime module
+in order to be compatible with old python versions
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{datetime.timedelta} (\emph{timedelta}) -- The delta between two dates
+
+\item[{Returns}] \leavevmode
+The number of seconds corresponding to timedelta.
+
+\item[{Return type}] \leavevmode
+float
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_hat\_xml() (in module src.logger)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.logger.update_hat_xml}\pysiglinewithargsret{\code{src.logger.}\bfcode{update\_hat\_xml}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands=}\optional{}}{}
+Create the xml file in logDir that contain all the xml file
+and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{application}) -- the directory to parse
+
+\item {}
+\textbf{str} -- the name of the application if there is any
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{options} Module}
+\label{commands/apidoc/src:module-src.options}\label{commands/apidoc/src:options-module}\index{src.options (module)}
+The Options class that manages the access to all options passed as
+parameters in salomeTools command lines
+\index{OptResult (class in src.options)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.OptResult}\pysigline{\strong{class }\code{src.options.}\bfcode{OptResult}}
+Bases: \code{object}
+
+An instance of this class will be the object manipulated
+in code of all salomeTools commands
+The aim of this class is to have an elegant syntax
+to manipulate the options.
+ex:
+print(options.level)
+5
+
+\end{fulllineitems}
+
+\index{Options (class in src.options)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options}\pysigline{\strong{class }\code{src.options.}\bfcode{Options}}
+Class to manage all salomeTools options
+\index{add\_option() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.add_option}\pysiglinewithargsret{\bfcode{add\_option}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString='`}, \emph{default=None}}{}
+Method to add an option to a command. It gets all attributes
+of an option and append it in the options field
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{helpString}) -- The short name of the option
+(ex ``l'' for level option).
+
+\item {}
+\textbf{str} -- The long name of the option
+(ex ``level'' for level option).
+
+\item {}
+\textbf{str} -- The type of the option (ex ``int'').
+
+\item {}
+\textbf{str} -- The name that will be used in the code.
+
+\item {}
+\textbf{str} -- The text to display
+when user ask for help on a command.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+Nothing.
+
+\item[{Return type}] \leavevmode
+NA
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{parse\_args() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.parse_args}\pysiglinewithargsret{\bfcode{parse\_args}}{\emph{argList=None}}{}
+Method that instantiates the class OptResult
+that gives access to all options in the code
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{list} (\emph{argList}) -- the raw list of arguments that were passed
+
+\item[{Returns}] \leavevmode
+optResult, args : optResult is the option instance
+to manipulate in the code. args
+is the full raw list of passed options
+
+\item[{Return type}] \leavevmode
+(class `common.options.OptResult',list)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_help() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.print_help}\pysiglinewithargsret{\bfcode{print\_help}}{}{}
+Method that display all options stored in self.options and there help
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+Nothing.
+
+\item[{Return type}] \leavevmode
+NA
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{printcolors} Module}
+\label{commands/apidoc/src:printcolors-module}\label{commands/apidoc/src:module-src.printcolors}\index{src.printcolors (module)}
+In this file is stored the mechanism that manage color prints in the terminal
+\index{cleancolor() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.cleancolor}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{cleancolor}}{\emph{message}}{}
+remove color from a colored text.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{message}) -- The text to be cleaned.
+
+\item[{Returns}] \leavevmode
+The cleaned text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_color\_map() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.print_color_map}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_color\_map}}{}{}
+This method prints the color map
+
+\end{fulllineitems}
+
+\index{print\_color\_range() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.print_color_range}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_color\_range}}{\emph{start}, \emph{end}}{}
+print possible range values for colors
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{int} (\emph{end}) -- The smaller value.
+
+\item {}
+\textbf{int} -- The bigger value.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_value() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.print_value}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_value}}{\emph{logger}, \emph{label}, \emph{value}, \emph{level=1}, \emph{suffix='`}}{}
+shortcut method to print a label and a value with the info color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{class logger} (\emph{logger}) -- the logger instance.
+
+\item {}
+\textbf{int} (\emph{level}) -- the label to print.
+
+\item {}
+\textbf{str} (\emph{suffix}) -- the value to print.
+
+\item {}
+\textbf{int} -- the level of verboseness.
+
+\item {}
+\textbf{str} -- the suffix to add at the end.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printc() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printc}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printc}}{\emph{txt}, \emph{code='`}}{}
+print a text with colors
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{code}) -- The text to be printed.
+
+\item {}
+\textbf{str} -- The color to use.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcError() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcError}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcError}}{\emph{txt}}{}
+print a text error color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcHeader() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcHeader}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcHeader}}{\emph{txt}}{}
+print a text header color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcHighlight() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcHighlight}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcHighlight}}{\emph{txt}}{}
+print a text highlight color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcInfo() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcInfo}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcInfo}}{\emph{txt}}{}
+print a text info color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcLabel() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcLabel}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcLabel}}{\emph{txt}}{}
+print a text label color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcSuccess() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcSuccess}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcSuccess}}{\emph{txt}}{}
+print a text success color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{printcWarning() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.printcolors.printcWarning}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcWarning}}{\emph{txt}}{}
+print a text warning color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{txt}) -- The text to be printed.
+
+\item[{Returns}] \leavevmode
+The colored text.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{product} Module}
+\label{commands/apidoc/src:module-src.product}\label{commands/apidoc/src:product-module}\index{src.product (module)}
+In this file are implemented the methods
+relative to the product notion of salomeTools
+\index{check\_config\_exists() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.check_config_exists}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_config\_exists}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{}
+Verify that the installation directory of a product in a base exists
+Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
+that is in it
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The global configuration
+
+\item {}
+\textbf{str} (\emph{prod\_dir}) -- The product installation directory path
+(without config-\textless{}i\textgreater{})
+
+\item {}
+\textbf{Config} -- The configuration specific to
+the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True or false is the installation is found or not
+and if it is found, the path of the found installation
+
+\item[{Return type}] \leavevmode
+(boolean, str)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_installation() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.check_installation}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_installation}}{\emph{product\_info}}{}
+Verify if a product is well installed. Checks install directory presence
+and some additional files if it is defined in the config
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if it is well installed
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_source() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.check_source}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_source}}{\emph{product\_info}}{}
+Verify if a sources of product is preset. Checks source directory presence
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if it is well installed
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_base\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_base_install_dir}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_base\_install\_dir}}{\emph{config}, \emph{prod\_info}, \emph{version}}{}
+Compute the installation directory of a product in base
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The global configuration
+
+\item {}
+\textbf{Config} -- The configuration specific to
+the product
+
+\item {}
+\textbf{str} (\emph{version}) -- The version of the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path of the product installation
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_install_dir}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_install\_dir}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{}
+Compute the installation directory of a given product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The global configuration
+
+\item {}
+\textbf{str} (\emph{version}) -- This corresponds to the value given by user in its
+application.pyconf for the specific product. If ``yes'', the
+user wants the product to be in base. If ``no'', he wants the
+product to be in the application workdir
+
+\item {}
+\textbf{str} -- The version of the product
+
+\item {}
+\textbf{Config} -- The configuration specific to
+the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path of the product installation
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_components() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_components}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_components}}{\emph{product\_info}}{}
+Get the component list to generate with the product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+The list of names of the components
+
+\item[{Return type}] \leavevmode
+List
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_config() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_config}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_config}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{}
+Get the specific configuration of a product from the global configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{config}) -- The global configuration
+
+\item {}
+\textbf{str} (\emph{product\_name}) -- The name of the product
+
+\item {}
+\textbf{boolean} (\emph{with\_install\_dir}) -- If false, do not provide an install
+directory (at false only for internal use
+of the function check\_config\_exists)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the specific configuration of the product
+
+\item[{Return type}] \leavevmode
+Config
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_dependencies() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_dependencies}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_dependencies}}{\emph{config}, \emph{product\_info}}{}
+Get recursively the list of products that are
+in the product\_info dependencies
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{product\_info}) -- The global configuration
+
+\item {}
+\textbf{Config} -- The configuration specific to
+the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of products in dependence
+
+\item[{Return type}] \leavevmode
+list
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_section() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_section}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_section}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{}
+Get the product description from the configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{Config} (\emph{config}) -- The global configuration
+
+\item {}
+\textbf{str} (\emph{section}) -- The product name
+
+\item {}
+\textbf{str} -- The version of the product
+
+\item {}
+\textbf{str} -- The searched section (if not None, the section is
+explicitly given
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The product description
+
+\item[{Return type}] \leavevmode
+Config
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_infos() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_products_infos}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_products\_infos}}{\emph{lproducts}, \emph{config}}{}
+Get the specific configuration of a list of products
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{List} (\emph{lproducts}) -- The list of product names
+
+\item {}
+\textbf{Config} (\emph{config}) -- The global configuration
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of tuples
+(product name, specific configuration of the product)
+
+\item[{Return type}] \leavevmode
+{[}(str, Config){]}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_compiles() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_compiles}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_compiles}}{\emph{product\_info}}{}
+Know if a product compiles or not
+(some products do not have a compilation procedure)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product compiles, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_env\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_env_script}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_env\_script}}{\emph{product\_info}}{}
+Know if a product has an environment script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product it has an environment script, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_logo() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_logo}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_logo}}{\emph{product\_info}}{}
+Know if a product has a logo (YACSGEN generate)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+The path of the logo if the product has a logo, else False
+
+\item[{Return type}] \leavevmode
+Str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_patches() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_patches}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_patches}}{\emph{product\_info}}{}
+Know if a product has one or more patches
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has one or more patches
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_salome\_gui() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_salome_gui}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_salome\_gui}}{\emph{product\_info}}{}
+Know if a product has a SALOME gui
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has a SALOME gui, else False
+
+\item[{Return type}] \leavevmode
+Boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_script}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_script}}{\emph{product\_info}}{}
+Know if a product has a compilation script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product it has a compilation script, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_autotools() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_autotools}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_autotools}}{\emph{product\_info}}{}
+Know if a product is compiled using the autotools
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is autotools, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cmake() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_cmake}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_cmake}}{\emph{product\_info}}{}
+Know if a product is compiled using the cmake
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is cmake, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cpp() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_cpp}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_cpp}}{\emph{product\_info}}{}
+Know if a product is cpp
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a cpp, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_debug() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_debug}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_debug}}{\emph{product\_info}}{}
+Know if a product is in debug mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is in debug mode, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_dev() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_dev}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_dev}}{\emph{product\_info}}{}
+Know if a product is in dev mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is in dev mode, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_fixed() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_fixed}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_fixed}}{\emph{product\_info}}{}
+Know if a product is fixed
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is fixed, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_generated() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_generated}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_generated}}{\emph{product\_info}}{}
+Know if a product is generated (YACSGEN)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is generated
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_mpi() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_mpi}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_mpi}}{\emph{product\_info}}{}
+Know if a product has openmpi in its dependencies
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has openmpi inits dependencies
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_native() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_native}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_native}}{\emph{product\_info}}{}
+Know if a product is native
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is native, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_salome() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_salome}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_salome}}{\emph{product\_info}}{}
+Know if a product is a SALOME module
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a SALOME module, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_sample() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_sample}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_sample}}{\emph{product\_info}}{}
+Know if a product has the sample type
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has the sample type, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_smesh\_plugin() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_smesh_plugin}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_smesh\_plugin}}{\emph{product\_info}}{}
+Know if a product is a SMESH plugin
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a SMESH plugin, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_vcs() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_vcs}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_vcs}}{\emph{product\_info}}{}
+Know if a product is download using git, svn or cvs (not archive)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{Config} (\emph{product\_info}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is vcs, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{pyconf} Module}
+\label{commands/apidoc/src:pyconf-module}\label{commands/apidoc/src:module-src.pyconf}\index{src.pyconf (module)}
+This is a configuration module for Python.
+
+This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
+earlier versions since it uses new-style classes.
+
+Development and testing has only been carried out (so far) on Python 2.3.4 and
+Python 2.4.2. See the test module (test\_config.py) included in the
+U\{distribution\textless{}\href{http://www.red-dove.com/python\_config}{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
+download link).
+
+A simple example - with the example configuration file:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+messages:
+[
+ \PYGZob{}
+ stream : {}`sys.stderr{}`
+ message: 'Welcome'
+ name: 'Harry'
+ \PYGZcb{}
+ \PYGZob{}
+ stream : {}`sys.stdout{}`
+ message: 'Welkom'
+ name: 'Ruud'
+ \PYGZcb{}
+ \PYGZob{}
+ stream : \$messages[0].stream
+ message: 'Bienvenue'
+ name: Yves
+ \PYGZcb{}
+]
+\end{Verbatim}
+
+a program to read the configuration would be:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k+kn}{import} \PYG{n}{Config}
+
+\PYG{n}{f} \PYG{o}{=} \PYG{n+nb}{file}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{simple.cfg}\PYG{l+s}{'}\PYG{p}{)}
+\PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)}
+\PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:}
+ \PYG{n}{s} \PYG{o}{=} \PYG{l+s}{'}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s}{'} \PYG{o}{\PYGZpc{}} \PYG{p}{(}\PYG{n}{m}\PYG{o}{.}\PYG{n}{message}\PYG{p}{,} \PYG{n}{m}\PYG{o}{.}\PYG{n}{name}\PYG{p}{)}
+ \PYG{k}{try}\PYG{p}{:}
+ \PYG{k}{print} \PYG{o}{\textgreater{}\textgreater{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s}
+ \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:}
+ \PYG{k}{print} \PYG{n}{e}
+\end{Verbatim}
+
+which, when run, would yield the console output:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
+\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
+\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
+\end{Verbatim}
+
+See U\{this tutorial\textless{}\href{http://www.red-dove.com/python\_config}{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
+information.
+
+\#modified for salomeTools
+@version: 0.3.7.1
+
+@author: Vinay Sajip
+
+@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
+
+@var streamOpener: The default stream opener. This is a factory function which
+takes a string (e.g. filename) and returns a stream suitable for reading. If
+unable to open the stream, an IOError exception should be thrown.
+
+The default value of this variable is L\{defaultStreamOpener\}. For an example
+of how it's used, see test\_config.py (search for streamOpener).
+\index{Config (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Config}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Mapping]{\code{src.pyconf.Mapping}}}
+
+This class represents a configuration, and is the only one which clients
+need to interface to, under normal circumstances.
+\index{Config.Namespace (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.Namespace}\pysigline{\strong{class }\bfcode{Namespace}}
+Bases: \code{object}
+
+This internal class is used for implementing default namespaces.
+
+An instance acts as a namespace.
+
+\end{fulllineitems}
+
+\index{addNamespace() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.addNamespace}\pysiglinewithargsret{\code{Config.}\bfcode{addNamespace}}{\emph{ns}, \emph{name=None}}{}
+Add a namespace to this configuration which can be used to evaluate
+(resolve) dotted-identifier expressions.
+@param ns: The namespace to be added.
+@type ns: A module or other namespace suitable for passing as an
+argument to vars().
+@param name: A name for the namespace, which, if specified, provides
+an additional level of indirection.
+@type name: str
+
+\end{fulllineitems}
+
+\index{getByPath() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.getByPath}\pysiglinewithargsret{\code{Config.}\bfcode{getByPath}}{\emph{path}}{}
+Obtain a value in the configuration via its path.
+@param path: The path of the required value
+@type path: str
+@return the value at the specified path.
+@rtype: any
+@raise ConfigError: If the path is invalid
+
+\end{fulllineitems}
+
+\index{load() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.load}\pysiglinewithargsret{\code{Config.}\bfcode{load}}{\emph{stream}}{}
+Load the configuration from the specified stream. Multiple streams can
+be used to populate the same instance, as long as there are no
+clashing keys. The stream is closed.
+@param stream: A stream from which the configuration is read.
+@type stream: A read-only stream (file-like object).
+@raise ConfigError: if keys in the loaded configuration clash with
+existing keys.
+@raise ConfigFormatError: if there is a syntax error in the stream.
+
+\end{fulllineitems}
+
+\index{removeNamespace() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.removeNamespace}\pysiglinewithargsret{\code{Config.}\bfcode{removeNamespace}}{\emph{ns}, \emph{name=None}}{}
+Remove a namespace added with L\{addNamespace\}.
+@param ns: The namespace to be removed.
+@param name: The name which was specified when L\{addNamespace\} was
+called.
+@type name: str
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigError}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigError}}
+Bases: \code{exceptions.Exception}
+
+This is the base class of exceptions raised by this module.
+
+\end{fulllineitems}
+
+\index{ConfigFormatError}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigFormatError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigFormatError}}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\code{src.pyconf.ConfigError}}}
+
+This is the base class of exceptions raised due to syntax errors in
+configurations.
+
+\end{fulllineitems}
+
+\index{ConfigInputStream (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigInputStream}}{\emph{stream}}{}
+Bases: \code{object}
+
+An input stream which can read either ANSI files with default encoding
+or Unicode files with BOMs.
+
+Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.
+\index{close() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.close}\pysiglinewithargsret{\bfcode{close}}{}{}
+\end{fulllineitems}
+
+\index{read() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.read}\pysiglinewithargsret{\bfcode{read}}{\emph{size}}{}
+\end{fulllineitems}
+
+\index{readline() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}\pysiglinewithargsret{\bfcode{readline}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigList (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList}\pysigline{\strong{class }\code{src.pyconf.}\bfcode{ConfigList}}
+Bases: \code{list}
+
+This class implements an ordered list of configurations and allows you
+to try getting the configuration from each entry in turn, returning
+the first successfully obtained value.
+\index{getByPath() (src.pyconf.ConfigList method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList.getByPath}\pysiglinewithargsret{\bfcode{getByPath}}{\emph{path}}{}
+Obtain a value from the first configuration in the list which defines
+it.
+
+@param path: The path of the value to retrieve.
+@type path: str
+@return: The value from the earliest configuration in the list which
+defines it.
+@rtype: any
+@raise ConfigError: If no configuration in the list has an entry with
+the specified path.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigMerger (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigMerger}}{\emph{resolver=\textless{}function defaultMergeResolve at 0x2379de8\textgreater{}}}{}
+Bases: \code{object}
+
+This class is used for merging two configurations. If a key exists in the
+merge operand but not the merge target, then the entry is copied from the
+merge operand to the merge target. If a key exists in both configurations,
+then a resolver (a callable) is called to decide how to handle the
+conflict.
+\index{handleMismatch() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}\pysiglinewithargsret{\bfcode{handleMismatch}}{\emph{obj1}, \emph{obj2}}{}
+Handle a mismatch between two objects.
+
+@param obj1: The object to merge into.
+@type obj1: any
+@param obj2: The object to merge.
+@type obj2: any
+
+\end{fulllineitems}
+
+\index{merge() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.merge}\pysiglinewithargsret{\bfcode{merge}}{\emph{merged}, \emph{mergee}}{}
+Merge two configurations. The second configuration is unchanged,
+and the first is changed to reflect the results of the merge.
+
+@param merged: The configuration to merge into.
+@type merged: L\{Config\}.
+@param mergee: The configuration to merge.
+@type mergee: L\{Config\}.
+
+\end{fulllineitems}
+
+\index{mergeMapping() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}\pysiglinewithargsret{\bfcode{mergeMapping}}{\emph{map1}, \emph{map2}}{}
+Merge two mappings recursively. The second mapping is unchanged,
+and the first is changed to reflect the results of the merge.
+
+@param map1: The mapping to merge into.
+@type map1: L\{Mapping\}.
+@param map2: The mapping to merge.
+@type map2: L\{Mapping\}.
+
+\end{fulllineitems}
+
+\index{mergeSequence() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}\pysiglinewithargsret{\bfcode{mergeSequence}}{\emph{seq1}, \emph{seq2}}{}
+Merge two sequences. The second sequence is unchanged,
+and the first is changed to have the elements of the second
+appended to it.
+
+@param seq1: The sequence to merge into.
+@type seq1: L\{Sequence\}.
+@param seq2: The sequence to merge.
+@type seq2: L\{Sequence\}.
+
+\end{fulllineitems}
+
+\index{overwriteKeys() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}\pysiglinewithargsret{\bfcode{overwriteKeys}}{\emph{map1}, \emph{seq2}}{}
+Renint variables. The second mapping is unchanged,
+and the first is changed depending the keys of the second mapping.
+@param map1: The mapping to reinit keys into.
+@type map1: L\{Mapping\}.
+@param map2: The mapping container reinit information.
+@type map2: L\{Mapping\}.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigOutputStream (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigOutputStream}}{\emph{stream}, \emph{encoding=None}}{}
+Bases: \code{object}
+
+An output stream which can write either ANSI files with default encoding
+or Unicode files with BOMs.
+
+Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.
+\index{close() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}\pysiglinewithargsret{\bfcode{close}}{}{}
+\end{fulllineitems}
+
+\index{flush() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}\pysiglinewithargsret{\bfcode{flush}}{}{}
+\end{fulllineitems}
+
+\index{write() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}\pysiglinewithargsret{\bfcode{write}}{\emph{data}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigReader (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigReader}}{\emph{config}}{}
+Bases: \code{object}
+
+This internal class implements a parser for configurations.
+\index{getChar() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getChar}\pysiglinewithargsret{\bfcode{getChar}}{}{}
+Get the next char from the stream. Update line and column numbers
+appropriately.
+
+@return: The next character from the stream.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{getToken() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getToken}\pysiglinewithargsret{\bfcode{getToken}}{}{}
+Get a token from the stream. String values are returned in a form
+where you need to eval() the returned value to get the actual
+string. The return value is (token\_type, token\_value).
+
+Multiline string tokenizing is thanks to David Janes (BlogMatrix)
+
+@return: The next token.
+@rtype: A token tuple.
+
+\end{fulllineitems}
+
+\index{load() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.load}\pysiglinewithargsret{\bfcode{load}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
+Load the configuration from the specified stream.
+
+@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+@param parent: The parent of the configuration (to which this reader
+belongs) in the hierarchy. Specified when the configuration is
+included in another one.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix of this configuration in the parent
+configuration. Should be specified whenever the parent is not None.
+@raise ConfigError: If parent is specified but suffix is not.
+@raise ConfigFormatError: If there are syntax errors in the stream.
+
+\end{fulllineitems}
+
+\index{location() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.location}\pysiglinewithargsret{\bfcode{location}}{}{}
+Return the current location (filename, line, column) in the stream
+as a string.
+
+Used when printing error messages,
+
+@return: A string representing a location in the stream being read.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{match() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.match}\pysiglinewithargsret{\bfcode{match}}{\emph{t}}{}
+Ensure that the current token type matches the specified value, and
+advance to the next token.
+
+@param t: The token type to match.
+@type t: A valid token type.
+@return: The token which was last read from the stream before this
+function is called.
+@rtype: a token tuple - see L\{getToken\}.
+@raise ConfigFormatError: If the token does not match what's expected.
+
+\end{fulllineitems}
+
+\index{parseFactor() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}\pysiglinewithargsret{\bfcode{parseFactor}}{}{}
+Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
+
+@return: the parsed factor
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}\pysiglinewithargsret{\bfcode{parseKeyValuePair}}{\emph{parent}}{}
+Parse a key-value pair, and add it to the provided L\{Mapping\}.
+
+@param parent: The mapping to add entries to.
+@type parent: A L\{Mapping\} instance.
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseMapping() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}\pysiglinewithargsret{\bfcode{parseMapping}}{\emph{parent}, \emph{suffix}}{}
+Parse a mapping.
+
+@param parent: The container to which the mapping will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L\{Mapping\} instance representing the mapping.
+@rtype: L\{Mapping\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseMappingBody() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}\pysiglinewithargsret{\bfcode{parseMappingBody}}{\emph{parent}}{}
+Parse the internals of a mapping, and add entries to the provided
+L\{Mapping\}.
+
+@param parent: The mapping to add entries to.
+@type parent: A L\{Mapping\} instance.
+
+\end{fulllineitems}
+
+\index{parseReference() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}\pysiglinewithargsret{\bfcode{parseReference}}{\emph{type}}{}
+Parse a reference.
+
+@return: the parsed reference
+@rtype: L\{Reference\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseScalar() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}\pysiglinewithargsret{\bfcode{parseScalar}}{}{}
+Parse a scalar - a terminal value such as a string or number, or
+an L\{Expression\} or L\{Reference\}.
+
+@return: the parsed scalar
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseSequence() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}\pysiglinewithargsret{\bfcode{parseSequence}}{\emph{parent}, \emph{suffix}}{}
+Parse a sequence.
+
+@param parent: The container to which the sequence will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L\{Sequence\} instance representing the sequence.
+@rtype: L\{Sequence\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseSuffix() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}\pysiglinewithargsret{\bfcode{parseSuffix}}{\emph{ref}}{}
+Parse a reference suffix.
+
+@param ref: The reference of which this suffix is a part.
+@type ref: L\{Reference\}.
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseTerm() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}\pysiglinewithargsret{\bfcode{parseTerm}}{}{}
+Parse a term in an additive expression (a + b, a - b)
+
+@return: the parsed term
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseValue() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}\pysiglinewithargsret{\bfcode{parseValue}}{\emph{parent}, \emph{suffix}}{}
+Parse a value.
+
+@param parent: The container to which the value will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: The value
+@rtype: any
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{setStream() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.setStream}\pysiglinewithargsret{\bfcode{setStream}}{\emph{stream}}{}
+Set the stream to the specified value, and prepare to read from it.
+
+@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigResolutionError}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigResolutionError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigResolutionError}}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\code{src.pyconf.ConfigError}}}
+
+This is the base class of exceptions raised due to semantic errors in
+configurations.
+
+\end{fulllineitems}
+
+\index{Container (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Container}}{\emph{parent}}{}
+Bases: \code{object}
+
+This internal class is the base class for mappings and sequences.
+
+@ivar path: A string which describes how to get
+to this instance from the root of the hierarchy.
+
+Example:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+a.list.of[1].or['more'].elements
+\end{Verbatim}
+\index{evaluate() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.evaluate}\pysiglinewithargsret{\bfcode{evaluate}}{\emph{item}}{}
+Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
+
+L\{Reference\} instances are evaluated using L\{Reference.resolve\},
+and L\{Expression\} instances are evaluated using
+L\{Expression.evaluate\}.
+
+@param item: The item to be evaluated.
+@type item: any
+@return: If the item is an instance of L\{Reference\} or L\{Expression\},
+the evaluated value is returned, otherwise the item is returned
+unchanged.
+
+\end{fulllineitems}
+
+\index{setPath() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.setPath}\pysiglinewithargsret{\bfcode{setPath}}{\emph{path}}{}
+Set the path for this instance.
+@param path: The path - a string which describes how to get
+to this instance from the root of the hierarchy.
+@type path: str
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.writeToStream}\pysiglinewithargsret{\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+@raise NotImplementedError: If a subclass does not override this
+
+\end{fulllineitems}
+
+\index{writeValue() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.writeValue}\pysiglinewithargsret{\bfcode{writeValue}}{\emph{value}, \emph{stream}, \emph{indent}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Expression (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Expression}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Expression}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
+Bases: \code{object}
+
+This internal class implements a value which is obtained by evaluating an expression.
+\index{evaluate() (src.pyconf.Expression method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Expression.evaluate}\pysiglinewithargsret{\bfcode{evaluate}}{\emph{container}}{}
+Evaluate this instance in the context of a container.
+
+@param container: The container to evaluate in from.
+@type container: L\{Container\}
+@return: The evaluated value.
+@rtype: any
+@raise ConfigResolutionError: If evaluation fails.
+@raise ZeroDivideError: If division by zero occurs.
+@raise TypeError: If the operation is invalid, e.g.
+subtracting one string from another.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Mapping (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Mapping}}{\emph{parent=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\code{src.pyconf.Container}}}
+
+This internal class implements key-value mappings in configurations.
+\index{addMapping() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.addMapping}\pysiglinewithargsret{\bfcode{addMapping}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
+Add a key-value mapping with a comment.
+
+@param key: The key for the mapping.
+@type key: str
+@param value: The value for the mapping.
+@type value: any
+@param comment: The comment for the key (can be None).
+@type comment: str
+@param setting: If True, ignore clashes. This is set
+to true when called from L\{\_\_setattr\_\_\}.
+@raise ConfigFormatError: If an existing key is seen
+again and setting is False.
+
+\end{fulllineitems}
+
+\index{get() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}, \emph{default=None}}{}
+Allows a dictionary-style get operation.
+
+\end{fulllineitems}
+
+\index{iteritems() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iteritems}\pysiglinewithargsret{\bfcode{iteritems}}{}{}
+\end{fulllineitems}
+
+\index{iterkeys() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iterkeys}\pysiglinewithargsret{\bfcode{iterkeys}}{}{}
+\end{fulllineitems}
+
+\index{keys() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.keys}\pysiglinewithargsret{\bfcode{keys}}{}{}
+Return the keys in a similar way to a dictionary.
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.writeToStream}\pysiglinewithargsret{\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Reference (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Reference}}{\emph{config}, \emph{type}, \emph{ident}}{}
+Bases: \code{object}
+
+This internal class implements a value which is a reference to another value.
+\index{addElement() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.addElement}\pysiglinewithargsret{\bfcode{addElement}}{\emph{type}, \emph{ident}}{}
+Add an element to the reference.
+
+@param type: The type of reference.
+@type type: BACKTICK or DOLLAR
+@param ident: The identifier which continues the reference.
+@type ident: str
+
+\end{fulllineitems}
+
+\index{findConfig() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.findConfig}\pysiglinewithargsret{\bfcode{findConfig}}{\emph{container}}{}
+Find the closest enclosing configuration to the specified container.
+
+@param container: The container to start from.
+@type container: L\{Container\}
+@return: The closest enclosing configuration, or None.
+@rtype: L\{Config\}
+
+\end{fulllineitems}
+
+\index{resolve() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.resolve}\pysiglinewithargsret{\bfcode{resolve}}{\emph{container}}{}
+Resolve this instance in the context of a container.
+
+@param container: The container to resolve from.
+@type container: L\{Container\}
+@return: The resolved value.
+@rtype: any
+@raise ConfigResolutionError: If resolution fails.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Sequence (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Sequence}}{\emph{parent=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\code{src.pyconf.Container}}}
+
+This internal class implements a value which is a sequence of other values.
+\index{Sequence.SeqIter (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter}\pysiglinewithargsret{\strong{class }\bfcode{SeqIter}}{\emph{seq}}{}
+Bases: \code{object}
+
+This internal class implements an iterator for a L\{Sequence\} instance.
+\index{next() (src.pyconf.Sequence.SeqIter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}\pysiglinewithargsret{\bfcode{next}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{append() (src.pyconf.Sequence method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.append}\pysiglinewithargsret{\code{Sequence.}\bfcode{append}}{\emph{item}, \emph{comment}}{}
+Add an item to the sequence.
+
+@param item: The item to add.
+@type item: any
+@param comment: A comment for the item.
+@type comment: str
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Sequence method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.writeToStream}\pysiglinewithargsret{\code{Sequence.}\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{deepCopyMapping() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.deepCopyMapping}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{deepCopyMapping}}{\emph{inMapping}}{}
+\end{fulllineitems}
+
+\index{defaultMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.defaultMergeResolve}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{defaultMergeResolve}}{\emph{map1}, \emph{map2}, \emph{key}}{}
+A default resolver for merge conflicts.
+Returns a string indicating what action to take to resolve the conflict.
+
+@param map1: The map being merged into.
+@type map1: L\{Mapping\}.
+@param map2: The map being used as the merge operand.
+@type map2: L\{Mapping\}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+\begin{description}
+\item[{@return: One of ``merge'', ``append'', ``mismatch'' or ``overwrite''}] \leavevmode
+indicating what action should be taken. This should
+be appropriate to the objects being merged - e.g.
+there is no point returning ``merge'' if the two objects
+are instances of L\{Sequence\}.
+
+\end{description}
+
+@rtype: str
+
+\end{fulllineitems}
+
+\index{defaultStreamOpener() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.defaultStreamOpener}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{defaultStreamOpener}}{\emph{name}}{}
+This function returns a read-only stream, given its name. The name passed
+in should correspond to an existing stream, otherwise an exception will be
+raised.
+
+This is the default value of L\{streamOpener\}; assign your own callable to
+streamOpener to return streams based on names. For example, you could use
+urllib2.urlopen().
+
+@param name: The name of a stream, most commonly a file name.
+@type name: str
+@return: A stream with the specified name.
+@rtype: A read-only stream (file-like object)
+
+\end{fulllineitems}
+
+\index{isWord() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.isWord}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{isWord}}{\emph{s}}{}
+See if a passed-in value is an identifier. If the value passed in is not a
+string, False is returned. An identifier consists of alphanumerics or
+underscore characters.
+
+Examples:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+isWord('a word') -\textgreater{}False
+isWord('award') -\textgreater{} True
+isWord(9) -\textgreater{} False
+isWord('a\_b\_c\_') -\textgreater{}True
+\end{Verbatim}
+
+@note: isWord(`9abc') will return True - not exactly correct, but adequate
+for the way it's used here.
+
+@param s: The name to be tested
+@type s: any
+@return: True if a word, else False
+@rtype: bool
+
+\end{fulllineitems}
+
+\index{makePath() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.makePath}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{makePath}}{\emph{prefix}, \emph{suffix}}{}
+Make a path from a prefix and suffix.
+
+Examples:
+makePath(`', `suffix') -\textgreater{} `suffix'
+makePath(`prefix', `suffix') -\textgreater{} `prefix.suffix'
+makePath(`prefix', `{[}1{]}') -\textgreater{} `prefix{[}1{]}'
+
+@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
+@type prefix: str
+@param suffix: The suffix to use. It is either an identifier or an index in brackets.
+@type suffix: str
+@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{overwriteMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.overwriteMergeResolve}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{overwriteMergeResolve}}{\emph{map1}, \emph{map2}, \emph{key}}{}
+An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
+but where a ``mismatch'' is detected, returns ``overwrite'' instead.
+
+@param map1: The map being merged into.
+@type map1: L\{Mapping\}.
+@param map2: The map being used as the merge operand.
+@type map2: L\{Mapping\}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{system} Module}
+\label{commands/apidoc/src:system-module}\label{commands/apidoc/src:module-src.system}\index{src.system (module)}
+In this file : all functions that do a system call,
+like open a browser or an editor, or call a git command
+\index{archive\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.system.archive_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{archive\_extract}}{\emph{from\_what}, \emph{where}, \emph{logger}}{}
+Extracts sources from an archive.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{where}) -- The path to the archive.
+
+\item {}
+\textbf{str} -- The path where to extract.
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to use.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True if the extraction is successful
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{cvs\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.system.cvs_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{cvs\_extract}}{\emph{protocol}, \emph{user}, \emph{server}, \emph{base}, \emph{tag}, \emph{product}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
+Extracts sources from a cvs repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{where}) -- The cvs protocol.
+
+\item {}
+\textbf{str} -- The user to be used.
+
+\item {}
+\textbf{str} -- The remote cvs server.
+
+\item {}
+\textbf{str} --
+.
+
+
+\item {}
+\textbf{str} -- The tag.
+
+\item {}
+\textbf{str} -- The product.
+
+\item {}
+\textbf{str} -- The path where to extract.
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to use.
+
+\item {}
+\textbf{boolean} (\emph{checkout}) -- If true use checkout cvs.
+
+\item {}
+\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when
+extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True if the extraction is successful
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{git\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.system.git_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{git\_extract}}{\emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{environment=None}}{}
+Extracts sources from a git repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{where}) -- The remote git repository.
+
+\item {}
+\textbf{str} -- The tag.
+
+\item {}
+\textbf{str} -- The path where to extract.
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to use.
+
+\item {}
+\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when
+extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True if the extraction is successful
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_in\_editor() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.system.show_in_editor}\pysiglinewithargsret{\code{src.system.}\bfcode{show\_in\_editor}}{\emph{editor}, \emph{filePath}, \emph{logger}}{}
+open filePath using editor.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{filePath}) -- The editor to use.
+
+\item {}
+\textbf{str} -- The path to the file to open.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{svn\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.system.svn_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{svn\_extract}}{\emph{user}, \emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
+Extracts sources from a svn repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{where}) -- The user to be used.
+
+\item {}
+\textbf{str} -- The remote git repository.
+
+\item {}
+\textbf{str} -- The tag.
+
+\item {}
+\textbf{str} -- The path where to extract.
+
+\item {}
+\textbf{Logger} (\emph{logger}) -- The logger instance to use.
+
+\item {}
+\textbf{boolean} (\emph{checkout}) -- If true use checkout svn.
+
+\item {}
+\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when
+extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True if the extraction is successful
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{template} Module}
+\label{commands/apidoc/src:template-module}\label{commands/apidoc/src:module-src.template}\index{src.template (module)}\index{MyTemplate (class in src.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate}\pysiglinewithargsret{\strong{class }\code{src.template.}\bfcode{MyTemplate}}{\emph{template}}{}
+Bases: \code{string.Template}
+\index{delimiter (src.template.MyTemplate attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.delimiter}\pysigline{\bfcode{delimiter}\strong{ = `\textbackslash{}xc2\textbackslash{}xa4'}}
+\end{fulllineitems}
+
+\index{pattern (src.template.MyTemplate attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.pattern}\pysigline{\bfcode{pattern}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x24c9d70\textgreater{}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{substitute() (in module src.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.template.substitute}\pysiglinewithargsret{\code{src.template.}\bfcode{substitute}}{\emph{template\_file}, \emph{subst\_dic}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{test\_module} Module}
+\label{commands/apidoc/src:module-src.test_module}\label{commands/apidoc/src:test-module-module}\index{src.test\_module (module)}\index{Test (class in src.test\_module)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test}\pysiglinewithargsret{\strong{class }\code{src.test\_module.}\bfcode{Test}}{\emph{config}, \emph{logger}, \emph{tmp\_working\_dir}, \emph{testbase='`}, \emph{grids=None}, \emph{sessions=None}, \emph{launcher='`}, \emph{show\_desktop=True}}{}~\index{generate\_launching\_commands() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_launching_commands}\pysiglinewithargsret{\bfcode{generate\_launching\_commands}}{}{}
+\end{fulllineitems}
+
+\index{generate\_script() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_script}\pysiglinewithargsret{\bfcode{generate\_script}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
+\end{fulllineitems}
+
+\index{get\_test\_timeout() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_test_timeout}\pysiglinewithargsret{\bfcode{get\_test\_timeout}}{\emph{test\_name}, \emph{default\_value}}{}
+\end{fulllineitems}
+
+\index{get\_tmp\_dir() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_tmp_dir}\pysiglinewithargsret{\bfcode{get\_tmp\_dir}}{}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase}\pysiglinewithargsret{\bfcode{prepare\_testbase}}{\emph{test\_base\_name}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_dir}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_git}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_svn}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
+\end{fulllineitems}
+
+\index{read\_results() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.read_results}\pysiglinewithargsret{\bfcode{read\_results}}{\emph{listTest}, \emph{has\_timed\_out}}{}
+\end{fulllineitems}
+
+\index{run\_all\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_all_tests}\pysiglinewithargsret{\bfcode{run\_all\_tests}}{}{}
+\end{fulllineitems}
+
+\index{run\_grid\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_grid_tests}\pysiglinewithargsret{\bfcode{run\_grid\_tests}}{}{}
+\end{fulllineitems}
+
+\index{run\_script() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_script}\pysiglinewithargsret{\bfcode{run\_script}}{\emph{script\_name}}{}
+\end{fulllineitems}
+
+\index{run\_session\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_session_tests}\pysiglinewithargsret{\bfcode{run\_session\_tests}}{}{}
+\end{fulllineitems}
+
+\index{run\_testbase\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_testbase_tests}\pysiglinewithargsret{\bfcode{run\_testbase\_tests}}{}{}
+\end{fulllineitems}
+
+\index{run\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_tests}\pysiglinewithargsret{\bfcode{run\_tests}}{\emph{listTest}, \emph{ignoreList}}{}
+\end{fulllineitems}
+
+\index{search\_known\_errors() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.search_known_errors}\pysiglinewithargsret{\bfcode{search\_known\_errors}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
+\end{fulllineitems}
+
+\index{write\_test\_margin() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.write_test_margin}\pysiglinewithargsret{\bfcode{write\_test\_margin}}{\emph{tab}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{getTmpDirDEFAULT() (in module src.test\_module)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}\pysiglinewithargsret{\code{src.test\_module.}\bfcode{getTmpDirDEFAULT}}{}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{\texttt{xmlManager} Module}
+\label{commands/apidoc/src:xmlmanager-module}\label{commands/apidoc/src:module-src.xmlManager}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile}\pysiglinewithargsret{\strong{class }\code{src.xmlManager.}\bfcode{ReadXmlFile}}{\emph{filePath}}{}
+Bases: \code{object}
+
+Class to manage reading of an xml log file
+\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}\pysiglinewithargsret{\bfcode{getRootAttrib}}{}{}
+Get the attibutes of the self.xmlroot
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+The attributes of the root node
+
+\item[{Return type}] \leavevmode
+dict
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}\pysiglinewithargsret{\bfcode{get\_attrib}}{\emph{node\_name}}{}
+Get the attibutes of the node node\_name in self.xmlroot
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{node\_name}) -- the name of the node
+
+\item[{Returns}] \leavevmode
+the attibutes of the node node\_name in self.xmlroot
+
+\item[{Return type}] \leavevmode
+dict
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}\pysiglinewithargsret{\bfcode{get\_node\_text}}{\emph{node}}{}
+Get the text of the first node that has name
+that corresponds to the parameter node
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{node}) -- the name of the node from which get the text
+
+\item[{Returns}] \leavevmode
+the text of the first node that has name
+that corresponds to the parameter node
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{XmlLogFile (class in src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile}\pysiglinewithargsret{\strong{class }\code{src.xmlManager.}\bfcode{XmlLogFile}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
+Bases: \code{object}
+
+Class to manage writing in salomeTools xml log file
+\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}\pysiglinewithargsret{\bfcode{add\_simple\_node}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{text}) -- the name of the node to add
+
+\item {}
+\textbf{str} -- the text of the node
+
+\item {}
+\textbf{dict} (\emph{attrib}) -- the dictionary containing the
+attribute of the new node
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}\pysiglinewithargsret{\bfcode{append\_node\_attrib}}{\emph{node\_name}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{node\_name}) -- The name of the node on which append text
+
+\item {}
+\textbf{dixt} (\emph{attrib}) -- The attrib to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}\pysiglinewithargsret{\bfcode{append\_node\_text}}{\emph{node\_name}, \emph{text}}{}
+Append a new text to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{text}) -- The name of the node on which append text
+
+\item {}
+\textbf{str} -- The text to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_tree() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}\pysiglinewithargsret{\bfcode{write\_tree}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
+Write the xml tree in the log file path. Add the stylesheet if asked.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{str} (\emph{stylesheet}) -- The stylesheet to apply to the xml file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{add\_simple\_node() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.add_simple_node}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{add\_simple\_node}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{etree.Element} (\emph{root\_node}) -- the Etree element where to add the new node
+
+\item {}
+\textbf{str} (\emph{text}) -- the name of the node to add
+
+\item {}
+\textbf{str} -- the text of the node
+
+\item {}
+\textbf{dict} (\emph{attrib}) -- the dictionary containing the
+attribute of the new node
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_attrib() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.append_node_attrib}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{append\_node\_attrib}}{\emph{root\_node}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{etree.Element} (\emph{root\_node}) -- the Etree element
+where to append the new attibutes
+
+\item {}
+\textbf{dixt} (\emph{attrib}) -- The attrib to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_node\_by\_attrib() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.find_node_by_attrib}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{find\_node\_by\_attrib}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}
+Find the nfirst ode from xmlroot that has name name\_node and that has in
+its attributes \{key : value\}. Return the node
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{etree.Element} (\emph{xmlroot}) -- the Etree element where to search
+
+\item {}
+\textbf{str} (\emph{value}) -- the name of node to search
+
+\item {}
+\textbf{str} -- the key to search
+
+\item {}
+\textbf{str} -- the value to search
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the found node
+
+\item[{Return type}] \leavevmode
+xmlroot etree.Element
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_report() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.write_report}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{write\_report}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{}
+Writes a report file from a XML tree.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{str} (\emph{stylesheet}) -- The path to the file to create
+
+\item {}
+\textbf{etree.Element} (\emph{xmlroot}) -- the Etree element to write to the file
+
+\item {}
+\textbf{str} -- The stylesheet to add to the begin of the file
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{Subpackages}
+\label{commands/apidoc/src:subpackages}
+
+\paragraph{colorama Package}
+\label{commands/apidoc/src.colorama:colorama-package}\label{commands/apidoc/src.colorama::doc}
+
+\subparagraph{\texttt{colorama} Package}
+\label{commands/apidoc/src.colorama:id1}\phantomsection\label{commands/apidoc/src.colorama:module-src.colorama}\index{src.colorama (module)}
+
+\subparagraph{\texttt{ansi} Module}
+\label{commands/apidoc/src.colorama:module-src.colorama.ansi}\label{commands/apidoc/src.colorama:ansi-module}\index{src.colorama.ansi (module)}
+This module generates ANSI character codes to printing colors to terminals.
+See: \href{http://en.wikipedia.org/wiki/ANSI\_escape\_code}{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
+\index{AnsiBack (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiBack}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}}
+\index{BLACK (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 40}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 44}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 46}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 42}}
+\end{fulllineitems}
+
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}\pysigline{\bfcode{LIGHTBLACK\_EX}\strong{ = 100}}
+\end{fulllineitems}
+
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}\pysigline{\bfcode{LIGHTBLUE\_EX}\strong{ = 104}}
+\end{fulllineitems}
+
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}\pysigline{\bfcode{LIGHTCYAN\_EX}\strong{ = 106}}
+\end{fulllineitems}
+
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}\pysigline{\bfcode{LIGHTGREEN\_EX}\strong{ = 102}}
+\end{fulllineitems}
+
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}\pysigline{\bfcode{LIGHTMAGENTA\_EX}\strong{ = 105}}
+\end{fulllineitems}
+
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}\pysigline{\bfcode{LIGHTRED\_EX}\strong{ = 101}}
+\end{fulllineitems}
+
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}\pysigline{\bfcode{LIGHTWHITE\_EX}\strong{ = 107}}
+\end{fulllineitems}
+
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}\pysigline{\bfcode{LIGHTYELLOW\_EX}\strong{ = 103}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 45}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}\pysigline{\bfcode{RED}\strong{ = 41}}
+\end{fulllineitems}
+
+\index{RESET (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}\pysigline{\bfcode{RESET}\strong{ = 49}}
+\end{fulllineitems}
+
+\index{WHITE (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}\pysigline{\bfcode{WHITE}\strong{ = 47}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 43}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiCodes (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiCodes}}
+Bases: \code{object}
+
+\end{fulllineitems}
+
+\index{AnsiCursor (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiCursor}}
+Bases: \code{object}
+\index{BACK() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}\pysiglinewithargsret{\bfcode{BACK}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{DOWN() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}\pysiglinewithargsret{\bfcode{DOWN}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}\pysiglinewithargsret{\bfcode{FORWARD}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{POS() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}\pysiglinewithargsret{\bfcode{POS}}{\emph{x=1}, \emph{y=1}}{}
+\end{fulllineitems}
+
+\index{UP() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}\pysiglinewithargsret{\bfcode{UP}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiFore (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiFore}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}}
+\index{BLACK (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 30}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 34}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 36}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 32}}
+\end{fulllineitems}
+
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}\pysigline{\bfcode{LIGHTBLACK\_EX}\strong{ = 90}}
+\end{fulllineitems}
+
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}\pysigline{\bfcode{LIGHTBLUE\_EX}\strong{ = 94}}
+\end{fulllineitems}
+
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}\pysigline{\bfcode{LIGHTCYAN\_EX}\strong{ = 96}}
+\end{fulllineitems}
+
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}\pysigline{\bfcode{LIGHTGREEN\_EX}\strong{ = 92}}
+\end{fulllineitems}
+
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}\pysigline{\bfcode{LIGHTMAGENTA\_EX}\strong{ = 95}}
+\end{fulllineitems}
+
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}\pysigline{\bfcode{LIGHTRED\_EX}\strong{ = 91}}
+\end{fulllineitems}
+
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}\pysigline{\bfcode{LIGHTWHITE\_EX}\strong{ = 97}}
+\end{fulllineitems}
+
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}\pysigline{\bfcode{LIGHTYELLOW\_EX}\strong{ = 93}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 35}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}\pysigline{\bfcode{RED}\strong{ = 31}}
+\end{fulllineitems}
+
+\index{RESET (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}\pysigline{\bfcode{RESET}\strong{ = 39}}
+\end{fulllineitems}
+
+\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}\pysigline{\bfcode{WHITE}\strong{ = 37}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 33}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiStyle (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiStyle}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}}
+\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}\pysigline{\bfcode{BRIGHT}\strong{ = 1}}
+\end{fulllineitems}
+
+\index{DIM (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}\pysigline{\bfcode{DIM}\strong{ = 2}}
+\end{fulllineitems}
+
+\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}\pysigline{\bfcode{NORMAL}\strong{ = 22}}
+\end{fulllineitems}
+
+\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}\pysigline{\bfcode{RESET\_ALL}\strong{ = 0}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{clear\_line() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{clear\_line}}{\emph{mode=2}}{}
+\end{fulllineitems}
+
+\index{clear\_screen() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{clear\_screen}}{\emph{mode=2}}{}
+\end{fulllineitems}
+
+\index{code\_to\_chars() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{code\_to\_chars}}{\emph{code}}{}
+\end{fulllineitems}
+
+\index{set\_title() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.set_title}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{set\_title}}{\emph{title}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{\texttt{ansitowin32} Module}
+\label{commands/apidoc/src.colorama:ansitowin32-module}\label{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}\pysiglinewithargsret{\strong{class }\code{src.colorama.ansitowin32.}\bfcode{AnsiToWin32}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
+Bases: \code{object}
+
+Implements a `write()' method which, on Windows, will strip ANSI character
+sequences from the text, and if outputting to a tty, will convert them into
+win32 function calls.
+\index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}\pysigline{\bfcode{ANSI\_CSI\_RE}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x3ff4610\textgreater{}}}
+\end{fulllineitems}
+
+\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}\pysigline{\bfcode{ANSI\_OSC\_RE}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x42d2cf0\textgreater{}}}
+\end{fulllineitems}
+
+\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}\pysiglinewithargsret{\bfcode{call\_win32}}{\emph{command}, \emph{params}}{}
+\end{fulllineitems}
+
+\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}\pysiglinewithargsret{\bfcode{convert\_ansi}}{\emph{paramstring}, \emph{command}}{}
+\end{fulllineitems}
+
+\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}\pysiglinewithargsret{\bfcode{convert\_osc}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}\pysiglinewithargsret{\bfcode{extract\_params}}{\emph{command}, \emph{paramstring}}{}
+\end{fulllineitems}
+
+\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}\pysiglinewithargsret{\bfcode{get\_win32\_calls}}{}{}
+\end{fulllineitems}
+
+\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}\pysiglinewithargsret{\bfcode{reset\_all}}{}{}
+\end{fulllineitems}
+
+\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}\pysiglinewithargsret{\bfcode{should\_wrap}}{}{}
+True if this class is actually needed. If false, then the output
+stream will not be affected, nor will win32 calls be issued, so
+wrapping stdout is not actually required. This will generally be
+False on non-Windows platforms, unless optional functionality like
+autoreset has been requested using kwargs to init()
+
+\end{fulllineitems}
+
+\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}\pysiglinewithargsret{\bfcode{write}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}\pysiglinewithargsret{\bfcode{write\_and\_convert}}{\emph{text}}{}
+Write the given text to our wrapped stream, stripping any ANSI
+sequences from the text, and optionally converting them into win32
+calls.
+
+\end{fulllineitems}
+
+\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}\pysiglinewithargsret{\bfcode{write\_plain\_text}}{\emph{text}, \emph{start}, \emph{end}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{StreamWrapper (class in src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}\pysiglinewithargsret{\strong{class }\code{src.colorama.ansitowin32.}\bfcode{StreamWrapper}}{\emph{wrapped}, \emph{converter}}{}
+Bases: \code{object}
+
+Wraps a stream (such as stdout), acting as a transparent proxy for all
+attribute access apart from method `write()', which is delegated to our
+Converter instance.
+\index{write() (src.colorama.ansitowin32.StreamWrapper method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}\pysiglinewithargsret{\bfcode{write}}{\emph{text}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}\pysiglinewithargsret{\code{src.colorama.ansitowin32.}\bfcode{is\_a\_tty}}{\emph{stream}}{}
+\end{fulllineitems}
+
+\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}\pysiglinewithargsret{\code{src.colorama.ansitowin32.}\bfcode{is\_stream\_closed}}{\emph{stream}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{\texttt{initialise} Module}
+\label{commands/apidoc/src.colorama:initialise-module}\label{commands/apidoc/src.colorama:module-src.colorama.initialise}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{colorama\_text}}{\emph{*args}, \emph{**kwds}}{}
+\end{fulllineitems}
+
+\index{deinit() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.deinit}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{deinit}}{}{}
+\end{fulllineitems}
+
+\index{init() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.init}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{init}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
+\end{fulllineitems}
+
+\index{reinit() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reinit}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{reinit}}{}{}
+\end{fulllineitems}
+
+\index{reset\_all() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{reset\_all}}{}{}
+\end{fulllineitems}
+
+\index{wrap\_stream() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{wrap\_stream}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{\texttt{win32} Module}
+\label{commands/apidoc/src.colorama:win32-module}\label{commands/apidoc/src.colorama:module-src.colorama.win32}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}\pysiglinewithargsret{\code{src.colorama.win32.}\bfcode{SetConsoleTextAttribute}}{\emph{*\_}}{}
+\end{fulllineitems}
+
+\index{winapi\_test() (in module src.colorama.win32)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}\pysiglinewithargsret{\code{src.colorama.win32.}\bfcode{winapi\_test}}{\emph{*\_}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{\texttt{winterm} Module}
+\label{commands/apidoc/src.colorama:winterm-module}\label{commands/apidoc/src.colorama:module-src.colorama.winterm}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinColor}}
+Bases: \code{object}
+\index{BLACK (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 0}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 1}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 3}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 2}}
+\end{fulllineitems}
+
+\index{GREY (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}\pysigline{\bfcode{GREY}\strong{ = 7}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 5}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}\pysigline{\bfcode{RED}\strong{ = 4}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 6}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{WinStyle (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinStyle}}
+Bases: \code{object}
+\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}\pysigline{\bfcode{BRIGHT}\strong{ = 8}}
+\end{fulllineitems}
+
+\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}\pysigline{\bfcode{BRIGHT\_BACKGROUND}\strong{ = 128}}
+\end{fulllineitems}
+
+\index{NORMAL (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}\pysigline{\bfcode{NORMAL}\strong{ = 0}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{WinTerm (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinTerm}}
+Bases: \code{object}
+\index{back() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}\pysiglinewithargsret{\bfcode{back}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}\pysiglinewithargsret{\bfcode{cursor\_adjust}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{erase\_line() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}\pysiglinewithargsret{\bfcode{erase\_line}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{erase\_screen() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}\pysiglinewithargsret{\bfcode{erase\_screen}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{fore() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}\pysiglinewithargsret{\bfcode{fore}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}\pysiglinewithargsret{\bfcode{get\_attrs}}{}{}
+\end{fulllineitems}
+
+\index{get\_position() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}\pysiglinewithargsret{\bfcode{get\_position}}{\emph{handle}}{}
+\end{fulllineitems}
+
+\index{reset\_all() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}\pysiglinewithargsret{\bfcode{reset\_all}}{\emph{on\_stderr=None}}{}
+\end{fulllineitems}
+
+\index{set\_attrs() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}\pysiglinewithargsret{\bfcode{set\_attrs}}{\emph{value}}{}
+\end{fulllineitems}
+
+\index{set\_console() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}\pysiglinewithargsret{\bfcode{set\_console}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}\pysiglinewithargsret{\bfcode{set\_cursor\_position}}{\emph{position=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{set\_title() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}\pysiglinewithargsret{\bfcode{set\_title}}{\emph{title}}{}
+\end{fulllineitems}
+
+\index{style() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}\pysiglinewithargsret{\bfcode{style}}{\emph{style=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\chapter{Release Notes}
+\label{index:release-notes}
+
+\section{Release notes}
+\label{release_notes/release_notes_5.0.0:release-notes}\label{release_notes/release_notes_5.0.0::doc}
+In construction.
+
+
+\renewcommand{\indexname}{Python Module Index}
+\begin{theindex}
+\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+\bigletter{s}
+\item {\texttt{src.\_\_init\_\_}}, \pageref{commands/apidoc/src:module-src.__init__}
+\item {\texttt{src.architecture}}, \pageref{commands/apidoc/src:module-src.architecture}
+\item {\texttt{src.colorama}}, \pageref{commands/apidoc/src.colorama:module-src.colorama}
+\item {\texttt{src.colorama.ansi}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansi}
+\item {\texttt{src.colorama.ansitowin32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}
+\item {\texttt{src.colorama.initialise}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.initialise}
+\item {\texttt{src.colorama.win32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.win32}
+\item {\texttt{src.colorama.winterm}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.winterm}
+\item {\texttt{src.compilation}}, \pageref{commands/apidoc/src:module-src.compilation}
+\item {\texttt{src.debug}}, \pageref{commands/apidoc/src:module-src.debug}
+\item {\texttt{src.ElementTree}}, \pageref{commands/apidoc/src:module-src.ElementTree}
+\item {\texttt{src.environment}}, \pageref{commands/apidoc/src:module-src.environment}
+\item {\texttt{src.fileEnviron}}, \pageref{commands/apidoc/src:module-src.fileEnviron}
+\item {\texttt{src.fork}}, \pageref{commands/apidoc/src:module-src.fork}
+\item {\texttt{src.logger}}, \pageref{commands/apidoc/src:module-src.logger}
+\item {\texttt{src.options}}, \pageref{commands/apidoc/src:module-src.options}
+\item {\texttt{src.printcolors}}, \pageref{commands/apidoc/src:module-src.printcolors}
+\item {\texttt{src.product}}, \pageref{commands/apidoc/src:module-src.product}
+\item {\texttt{src.pyconf}}, \pageref{commands/apidoc/src:module-src.pyconf}
+\item {\texttt{src.system}}, \pageref{commands/apidoc/src:module-src.system}
+\item {\texttt{src.template}}, \pageref{commands/apidoc/src:module-src.template}
+\item {\texttt{src.test\_module}}, \pageref{commands/apidoc/src:module-src.test_module}
+\item {\texttt{src.xmlManager}}, \pageref{commands/apidoc/src:module-src.xmlManager}
+\end{theindex}
+
+\renewcommand{\indexname}{Index}
+\printindex
+\end{document}
--- /dev/null
+\babel@toc {english}{}
+\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}
+\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}
+\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}
+\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}
+\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}
+\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}
+\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}
+\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}
+\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}
+\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{4}{section.1.3}
+\contentsline {subsection}{\numberline {1.3.1}Usage}{4}{subsection.1.3.1}
+\contentsline {subsubsection}{Options of sat}{4}{subsubsection*.7}
+\contentsline {paragraph}{\emph {--help or -h}}{5}{paragraph*.8}
+\contentsline {paragraph}{\emph {--debug or -g}}{5}{paragraph*.9}
+\contentsline {paragraph}{\emph {--verbose or -v}}{5}{paragraph*.10}
+\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}
+\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}
+\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}
+\contentsline {subsubsection}{Compile SALOME}{5}{subsubsection*.13}
+\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}
+\contentsline {section}{\numberline {2.1}Command config}{7}{section.2.1}
+\contentsline {subsection}{\numberline {2.1.1}Description}{7}{subsection.2.1.1}
+\contentsline {subsection}{\numberline {2.1.2}Usage}{7}{subsection.2.1.2}
+\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}
+\contentsline {section}{\numberline {2.2}Command prepare}{8}{section.2.2}
+\contentsline {subsection}{\numberline {2.2.1}Description}{8}{subsection.2.2.1}
+\contentsline {subsection}{\numberline {2.2.2}Remarks}{8}{subsection.2.2.2}
+\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{8}{subsubsection*.14}
+\contentsline {subsubsection}{Dev mode}{9}{subsubsection*.15}
+\contentsline {subsection}{\numberline {2.2.3}Usage}{9}{subsection.2.2.3}
+\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{9}{subsection.2.2.4}
+\contentsline {section}{\numberline {2.3}Command compile}{10}{section.2.3}
+\contentsline {subsection}{\numberline {2.3.1}Description}{10}{subsection.2.3.1}
+\contentsline {subsection}{\numberline {2.3.2}Usage}{10}{subsection.2.3.2}
+\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{11}{subsection.2.3.3}
+\contentsline {section}{\numberline {2.4}Command launcher}{11}{section.2.4}
+\contentsline {subsection}{\numberline {2.4.1}Description}{11}{subsection.2.4.1}
+\contentsline {subsection}{\numberline {2.4.2}Usage}{11}{subsection.2.4.2}
+\contentsline {subsection}{\numberline {2.4.3}Configuration}{11}{subsection.2.4.3}
+\contentsline {section}{\numberline {2.5}Command application}{12}{section.2.5}
+\contentsline {subsection}{\numberline {2.5.1}Description}{12}{subsection.2.5.1}
+\contentsline {subsection}{\numberline {2.5.2}Usage}{12}{subsection.2.5.2}
+\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{12}{subsection.2.5.3}
+\contentsline {section}{\numberline {2.6}Command log}{13}{section.2.6}
+\contentsline {subsection}{\numberline {2.6.1}Description}{13}{subsection.2.6.1}
+\contentsline {subsection}{\numberline {2.6.2}Usage}{13}{subsection.2.6.2}
+\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{13}{subsection.2.6.3}
+\contentsline {section}{\numberline {2.7}Command environ}{13}{section.2.7}
+\contentsline {subsection}{\numberline {2.7.1}Description}{13}{subsection.2.7.1}
+\contentsline {subsection}{\numberline {2.7.2}Usage}{14}{subsection.2.7.2}
+\contentsline {subsection}{\numberline {2.7.3}Configuration}{14}{subsection.2.7.3}
+\contentsline {section}{\numberline {2.8}Command clean}{15}{section.2.8}
+\contentsline {subsection}{\numberline {2.8.1}Description}{15}{subsection.2.8.1}
+\contentsline {subsection}{\numberline {2.8.2}Usage}{15}{subsection.2.8.2}
+\contentsline {subsection}{\numberline {2.8.3}Availables options}{16}{subsection.2.8.3}
+\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{16}{subsection.2.8.4}
+\contentsline {section}{\numberline {2.9}Command package}{16}{section.2.9}
+\contentsline {subsection}{\numberline {2.9.1}Description}{16}{subsection.2.9.1}
+\contentsline {subsection}{\numberline {2.9.2}Usage}{16}{subsection.2.9.2}
+\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{17}{subsection.2.9.3}
+\contentsline {section}{\numberline {2.10}Command generate}{17}{section.2.10}
+\contentsline {subsection}{\numberline {2.10.1}Description}{17}{subsection.2.10.1}
+\contentsline {subsection}{\numberline {2.10.2}Remarks}{18}{subsection.2.10.2}
+\contentsline {subsection}{\numberline {2.10.3}Usage}{18}{subsection.2.10.3}
+\contentsline {chapter}{\numberline {3}Developer documentation}{19}{chapter.3}
+\contentsline {section}{\numberline {3.1}Add a user custom command}{19}{section.3.1}
+\contentsline {subsection}{\numberline {3.1.1}Introduction}{19}{subsection.3.1.1}
+\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{19}{subsection.3.1.2}
+\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{20}{subsection.3.1.3}
+\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{20}{subsection.3.1.4}
+\contentsline {subsection}{\numberline {3.1.5}HELLO example}{20}{subsection.3.1.5}
+\contentsline {chapter}{\numberline {4}Code documentation}{23}{chapter.4}
+\contentsline {section}{\numberline {4.1}src}{23}{section.4.1}
+\contentsline {subsection}{\numberline {4.1.1}src Package}{23}{subsection.4.1.1}
+\contentsline {subsubsection}{\texttt {src} Package}{23}{subsubsection*.16}
+\contentsline {subsubsection}{\texttt {ElementTree} Module}{25}{subsubsection*.59}
+\contentsline {subsubsection}{\texttt {architecture} Module}{26}{subsubsection*.91}
+\contentsline {subsubsection}{\texttt {compilation} Module}{27}{subsubsection*.98}
+\contentsline {subsubsection}{\texttt {debug} Module}{28}{subsubsection*.117}
+\contentsline {subsubsection}{\texttt {environment} Module}{29}{subsubsection*.131}
+\contentsline {subsubsection}{\texttt {fileEnviron} Module}{33}{subsubsection*.169}
+\contentsline {subsubsection}{\texttt {fork} Module}{38}{subsubsection*.234}
+\contentsline {subsubsection}{\texttt {logger} Module}{38}{subsubsection*.240}
+\contentsline {subsubsection}{\texttt {options} Module}{40}{subsubsection*.253}
+\contentsline {subsubsection}{\texttt {printcolors} Module}{41}{subsubsection*.259}
+\contentsline {subsubsection}{\texttt {product} Module}{42}{subsubsection*.272}
+\contentsline {subsubsection}{\texttt {pyconf} Module}{46}{subsubsection*.302}
+\contentsline {subsubsection}{\texttt {system} Module}{53}{subsubsection*.374}
+\contentsline {subsubsection}{\texttt {template} Module}{55}{subsubsection*.380}
+\contentsline {subsubsection}{\texttt {test\_module} Module}{55}{subsubsection*.385}
+\contentsline {subsubsection}{\texttt {xmlManager} Module}{56}{subsubsection*.405}
+\contentsline {subsubsection}{Subpackages}{57}{subsubsection*.419}
+\contentsline {paragraph}{colorama Package}{57}{paragraph*.420}
+\contentsline {subparagraph}{\texttt {colorama} Package}{57}{subparagraph*.421}
+\contentsline {subparagraph}{\texttt {ansi} Module}{57}{subparagraph*.423}
+\contentsline {subparagraph}{\texttt {ansitowin32} Module}{59}{subparagraph*.476}
+\contentsline {subparagraph}{\texttt {initialise} Module}{60}{subparagraph*.494}
+\contentsline {subparagraph}{\texttt {win32} Module}{60}{subparagraph*.501}
+\contentsline {subparagraph}{\texttt {winterm} Module}{60}{subparagraph*.504}
+\contentsline {chapter}{\numberline {5}Release Notes}{63}{chapter.5}
+\contentsline {section}{\numberline {5.1}Release notes}{63}{section.5.1}
+\contentsline {chapter}{Python Module Index}{65}{section*.532}
+\contentsline {chapter}{Index}{67}{section*.533}
--- /dev/null
+%
+% sphinx.sty
+%
+% Adapted from the old python.sty, mostly written by Fred Drake,
+% by Georg Brandl.
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)]
+
+\RequirePackage{textcomp}
+\RequirePackage{fancyhdr}
+\RequirePackage{fancybox}
+\RequirePackage{titlesec}
+\RequirePackage{tabulary}
+\RequirePackage{amsmath} % for \text
+\RequirePackage{makeidx}
+\RequirePackage{framed}
+\RequirePackage{ifthen}
+\RequirePackage{color}
+% For highlighted code.
+\RequirePackage{fancyvrb}
+% For table captions.
+\RequirePackage{threeparttable}
+% Handle footnotes in tables.
+\RequirePackage{footnote}
+\makesavenoteenv{tabulary}
+% For floating figures in the text.
+\RequirePackage{wrapfig}
+% Separate paragraphs by space by default.
+\RequirePackage{parskip}
+
+% Redefine these colors to your liking in the preamble.
+\definecolor{TitleColor}{rgb}{0.126,0.263,0.361}
+\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486}
+\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388}
+% Redefine these colors to something not white if you want to have colored
+% background and border for code examples.
+\definecolor{VerbatimColor}{rgb}{1,1,1}
+\definecolor{VerbatimBorderColor}{rgb}{1,1,1}
+
+% Uncomment these two lines to ignore the paper size and make the page
+% size more like a typical published manual.
+%\renewcommand{\paperheight}{9in}
+%\renewcommand{\paperwidth}{8.5in} % typical squarish manual
+%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
+
+% For graphicx, check if we are compiling under latex or pdflatex.
+\ifx\pdftexversion\undefined
+ \usepackage{graphicx}
+\else
+ \usepackage[pdftex]{graphicx}
+\fi
+
+% for PDF output, use colors and maximal compression
+\newif\ifsphinxpdfoutput\sphinxpdfoutputfalse
+\ifx\pdfoutput\undefined\else\ifcase\pdfoutput
+ \let\py@NormalColor\relax
+ \let\py@TitleColor\relax
+\else
+ \sphinxpdfoutputtrue
+ \input{pdfcolor}
+ \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
+ \def\py@TitleColor{\color{TitleColor}}
+ \pdfcompresslevel=9
+\fi\fi
+
+% XeLaTeX can do colors, too
+\ifx\XeTeXrevision\undefined\else
+ \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
+ \def\py@TitleColor{\color{TitleColor}}
+\fi
+
+% Increase printable page size (copied from fullpage.sty)
+\topmargin 0pt
+\advance \topmargin by -\headheight
+\advance \topmargin by -\headsep
+
+% attempt to work a little better for A4 users
+\textheight \paperheight
+\advance\textheight by -2in
+
+\oddsidemargin 0pt
+\evensidemargin 0pt
+%\evensidemargin -.25in % for ``manual size'' documents
+\marginparwidth 0.5in
+
+\textwidth \paperwidth
+\advance\textwidth by -2in
+
+
+% Style parameters and macros used by most documents here
+\raggedbottom
+\sloppy
+\hbadness = 5000 % don't print trivial gripes
+
+\pagestyle{empty} % start this way; change for
+\pagenumbering{roman} % ToC & chapters
+
+% Use this to set the font family for headers and other decor:
+\newcommand{\py@HeaderFamily}{\sffamily\bfseries}
+
+% Redefine the 'normal' header/footer style when using "fancyhdr" package:
+\@ifundefined{fancyhf}{}{
+ % Use \pagestyle{normal} as the primary pagestyle for text.
+ \fancypagestyle{normal}{
+ \fancyhf{}
+ \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
+ \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
+ \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
+ \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}}
+ \renewcommand{\headrulewidth}{0.4pt}
+ \renewcommand{\footrulewidth}{0.4pt}
+ }
+ % Update the plain style so we get the page number & footer line,
+ % but not a chapter or section title. This is to keep the first
+ % page of a chapter and the blank page between chapters `clean.'
+ \fancypagestyle{plain}{
+ \fancyhf{}
+ \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
+ \renewcommand{\headrulewidth}{0pt}
+ \renewcommand{\footrulewidth}{0.4pt}
+ }
+}
+
+% Some custom font markup commands.
+%
+\newcommand{\strong}[1]{{\bf #1}}
+\newcommand{\code}[1]{\texttt{#1}}
+\newcommand{\bfcode}[1]{\code{\bfseries#1}}
+\newcommand{\email}[1]{\textsf{#1}}
+
+% Redefine the Verbatim environment to allow border and background colors.
+% The original environment is still used for verbatims within tables.
+\let\OriginalVerbatim=\Verbatim
+\let\endOriginalVerbatim=\endVerbatim
+
+% Play with vspace to be able to keep the indentation.
+\newlength\distancetoright
+\def\mycolorbox#1{%
+ \setlength\distancetoright{\linewidth}%
+ \advance\distancetoright -\@totalleftmargin %
+ \fcolorbox{VerbatimBorderColor}{VerbatimColor}{%
+ \begin{minipage}{\distancetoright}%
+ #1
+ \end{minipage}%
+ }%
+}
+\def\FrameCommand{\mycolorbox}
+
+\renewcommand{\Verbatim}[1][1]{%
+ % list starts new par, but we don't want it to be set apart vertically
+ \bgroup\parskip=0pt%
+ \smallskip%
+ % The list environement is needed to control perfectly the vertical
+ % space.
+ \list{}{%
+ \setlength\parskip{0pt}%
+ \setlength\itemsep{0ex}%
+ \setlength\topsep{0ex}%
+ \setlength\partopsep{0pt}%
+ \setlength\leftmargin{0pt}%
+ }%
+ \item\MakeFramed {\FrameRestore}%
+ \small%
+ \OriginalVerbatim[#1]%
+}
+\renewcommand{\endVerbatim}{%
+ \endOriginalVerbatim%
+ \endMakeFramed%
+ \endlist%
+ % close group to restore \parskip
+ \egroup%
+}
+
+
+% \moduleauthor{name}{email}
+\newcommand{\moduleauthor}[2]{}
+
+% \sectionauthor{name}{email}
+\newcommand{\sectionauthor}[2]{}
+
+% Augment the sectioning commands used to get our own font family in place,
+% and reset some internal data items:
+\titleformat{\section}{\Large\py@HeaderFamily}%
+ {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsection}{\large\py@HeaderFamily}%
+ {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsubsection}{\py@HeaderFamily}%
+ {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\paragraph}{\small\py@HeaderFamily}%
+ {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor}
+
+% {fulllineitems} is the main environment for object descriptions.
+%
+\newcommand{\py@itemnewline}[1]{%
+ \@tempdima\linewidth%
+ \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
+}
+
+\newenvironment{fulllineitems}{
+ \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
+ \rightmargin 0pt \topsep -\parskip \partopsep \parskip
+ \itemsep -\parsep
+ \let\makelabel=\py@itemnewline}
+}{\end{list}}
+
+% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
+\newcommand{\optional}[1]{%
+ {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
+
+\newlength{\py@argswidth}
+\newcommand{\py@sigparams}[2]{%
+ \parbox[t]{\py@argswidth}{#1\code{)}#2}}
+\newcommand{\pysigline}[1]{\item[#1]\nopagebreak}
+\newcommand{\pysiglinewithargsret}[3]{%
+ \settowidth{\py@argswidth}{#1\code{(}}%
+ \addtolength{\py@argswidth}{-2\py@argswidth}%
+ \addtolength{\py@argswidth}{\linewidth}%
+ \item[#1\code{(}\py@sigparams{#2}{#3}]}
+
+% Production lists
+%
+\newenvironment{productionlist}{
+% \def\optional##1{{\Large[}##1{\Large]}}
+ \def\production##1##2{\\\code{##1}&::=&\code{##2}}
+ \def\productioncont##1{\\& &\code{##1}}
+ \parindent=2em
+ \indent
+ \begin{tabular}{lcl}
+}{%
+ \end{tabular}
+}
+
+% Notices / Admonitions
+%
+\newlength{\py@noticelength}
+
+\newcommand{\py@heavybox}{
+ \setlength{\fboxrule}{1pt}
+ \setlength{\fboxsep}{6pt}
+ \setlength{\py@noticelength}{\linewidth}
+ \addtolength{\py@noticelength}{-2\fboxsep}
+ \addtolength{\py@noticelength}{-2\fboxrule}
+ %\setlength{\shadowsize}{3pt}
+ \Sbox
+ \minipage{\py@noticelength}
+}
+\newcommand{\py@endheavybox}{
+ \endminipage
+ \endSbox
+ \fbox{\TheSbox}
+}
+
+\newcommand{\py@lightbox}{{%
+ \setlength\parskip{0pt}\par
+ \rule[0ex]{\linewidth}{0.5pt}%
+ \par\vspace{-0.5ex}%
+ }}
+\newcommand{\py@endlightbox}{{%
+ \setlength{\parskip}{0pt}%
+ \par\rule[0.5ex]{\linewidth}{0.5pt}%
+ \par\vspace{-0.5ex}%
+ }}
+
+% Some are quite plain:
+\newcommand{\py@noticestart@note}{\py@lightbox}
+\newcommand{\py@noticeend@note}{\py@endlightbox}
+\newcommand{\py@noticestart@hint}{\py@lightbox}
+\newcommand{\py@noticeend@hint}{\py@endlightbox}
+\newcommand{\py@noticestart@important}{\py@lightbox}
+\newcommand{\py@noticeend@important}{\py@endlightbox}
+\newcommand{\py@noticestart@tip}{\py@lightbox}
+\newcommand{\py@noticeend@tip}{\py@endlightbox}
+
+% Others gets more visible distinction:
+\newcommand{\py@noticestart@warning}{\py@heavybox}
+\newcommand{\py@noticeend@warning}{\py@endheavybox}
+\newcommand{\py@noticestart@caution}{\py@heavybox}
+\newcommand{\py@noticeend@caution}{\py@endheavybox}
+\newcommand{\py@noticestart@attention}{\py@heavybox}
+\newcommand{\py@noticeend@attention}{\py@endheavybox}
+\newcommand{\py@noticestart@danger}{\py@heavybox}
+\newcommand{\py@noticeend@danger}{\py@endheavybox}
+\newcommand{\py@noticestart@error}{\py@heavybox}
+\newcommand{\py@noticeend@error}{\py@endheavybox}
+
+\newenvironment{notice}[2]{
+ \def\py@noticetype{#1}
+ \csname py@noticestart@#1\endcsname
+ \strong{#2}
+}{\csname py@noticeend@\py@noticetype\endcsname}
+
+% Allow the release number to be specified independently of the
+% \date{}. This allows the date to reflect the document's date and
+% release to specify the release that is documented.
+%
+\newcommand{\py@release}{}
+\newcommand{\version}{}
+\newcommand{\shortversion}{}
+\newcommand{\releaseinfo}{}
+\newcommand{\releasename}{Release}
+\newcommand{\release}[1]{%
+ \renewcommand{\py@release}{\releasename\space\version}%
+ \renewcommand{\version}{#1}}
+\newcommand{\setshortversion}[1]{%
+ \renewcommand{\shortversion}{#1}}
+\newcommand{\setreleaseinfo}[1]{%
+ \renewcommand{\releaseinfo}{#1}}
+
+% Allow specification of the author's address separately from the
+% author's name. This can be used to format them differently, which
+% is a good thing.
+%
+\newcommand{\py@authoraddress}{}
+\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
+
+% This sets up the fancy chapter headings that make the documents look
+% at least a little better than the usual LaTeX output.
+%
+\@ifundefined{ChTitleVar}{}{
+ \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
+ \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
+ \ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily}
+ % This creates chapter heads without the leading \vspace*{}:
+ \def\@makechapterhead#1{%
+ {\parindent \z@ \raggedright \normalfont
+ \ifnum \c@secnumdepth >\m@ne
+ \DOCH
+ \fi
+ \interlinepenalty\@M
+ \DOTI{#1}
+ }
+ }
+}
+
+% Redefine description environment so that it is usable inside fulllineitems.
+%
+\renewcommand{\description}{%
+ \list{}{\labelwidth\z@%
+ \itemindent-\leftmargin%
+ \labelsep5pt%
+ \let\makelabel=\descriptionlabel}}
+
+% Definition lists; requested by AMK for HOWTO documents. Probably useful
+% elsewhere as well, so keep in in the general style support.
+%
+\newenvironment{definitions}{%
+ \begin{description}%
+ \def\term##1{\item[##1]\mbox{}\\*[0mm]}
+}{%
+ \end{description}%
+}
+
+% Tell TeX about pathological hyphenation cases:
+\hyphenation{Base-HTTP-Re-quest-Hand-ler}
+
+
+% The following is stuff copied from docutils' latex writer.
+%
+\newcommand{\optionlistlabel}[1]{\bf #1 \hfill}
+\newenvironment{optionlist}[1]
+{\begin{list}{}
+ {\setlength{\labelwidth}{#1}
+ \setlength{\rightmargin}{1cm}
+ \setlength{\leftmargin}{\rightmargin}
+ \addtolength{\leftmargin}{\labelwidth}
+ \addtolength{\leftmargin}{\labelsep}
+ \renewcommand{\makelabel}{\optionlistlabel}}
+}{\end{list}}
+
+\newlength{\lineblockindentation}
+\setlength{\lineblockindentation}{2.5em}
+\newenvironment{lineblock}[1]
+{\begin{list}{}
+ {\setlength{\partopsep}{\parskip}
+ \addtolength{\partopsep}{\baselineskip}
+ \topsep0pt\itemsep0.15\baselineskip\parsep0pt
+ \leftmargin#1}
+ \raggedright}
+{\end{list}}
+
+% Redefine includgraphics for avoiding images larger than the screen size
+% If the size is not specified.
+\let\py@Oldincludegraphics\includegraphics
+
+\newbox\image@box%
+\newdimen\image@width%
+\renewcommand\includegraphics[2][\@empty]{%
+ \ifx#1\@empty%
+ \setbox\image@box=\hbox{\py@Oldincludegraphics{#2}}%
+ \image@width\wd\image@box%
+ \ifdim \image@width>\linewidth%
+ \setbox\image@box=\hbox{\py@Oldincludegraphics[width=\linewidth]{#2}}%
+ \box\image@box%
+ \else%
+ \py@Oldincludegraphics{#2}%
+ \fi%
+ \else%
+ \py@Oldincludegraphics[#1]{#2}%
+ \fi%
+}
+
+
+% Fix the index environment to add an entry to the Table of
+% Contents; this is much nicer than just having to jump to the end of the book
+% and flip around, especially with multiple indexes.
+%
+% A similiar fix must be done to the bibliography environment, although
+% dependant on document class. In particular, the '\addcontentsline' command
+% should use 'chapter' for a report and 'section' for an article.
+% See sphinxmanual.cls and sphinxhowto.cls for specific fixes.
+%
+\let\py@OldTheindex=\theindex
+\renewcommand{\theindex}{
+ \cleardoublepage
+ \phantomsection
+ \py@OldTheindex
+ \addcontentsline{toc}{chapter}{\indexname}
+}
+
+% Include hyperref last.
+\RequirePackage[colorlinks,breaklinks,
+ linkcolor=InnerLinkColor,filecolor=OuterLinkColor,
+ menucolor=OuterLinkColor,urlcolor=OuterLinkColor,
+ citecolor=InnerLinkColor]{hyperref}
+% Fix anchor placement for figures with captions.
+% (Note: we don't use a package option here; instead, we give an explicit
+% \capstart for figures that actually have a caption.)
+\RequirePackage{hypcap}
+
+% From docutils.writers.latex2e
+\providecommand{\DUspan}[2]{%
+ {% group ("span") to limit the scope of styling commands
+ \@for\node@class@name:=#1\do{%
+ \ifcsname docutilsrole\node@class@name\endcsname%
+ \csname docutilsrole\node@class@name\endcsname%
+ \fi%
+ }%
+ {#2}% node content
+ }% close "span"
+}
+
+\providecommand*{\DUprovidelength}[2]{
+ \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{}
+}
+
+\DUprovidelength{\DUlineblockindent}{2.5em}
+\ifthenelse{\isundefined{\DUlineblock}}{
+ \newenvironment{DUlineblock}[1]{%
+ \list{}{\setlength{\partopsep}{\parskip}
+ \addtolength{\partopsep}{\baselineskip}
+ \setlength{\topsep}{0pt}
+ \setlength{\itemsep}{0.15\baselineskip}
+ \setlength{\parsep}{0pt}
+ \setlength{\leftmargin}{#1}}
+ \raggedright
+ }
+ {\endlist}
+}{}
+
+
+% From footmisc.sty: allows footnotes in titles
+\let\FN@sf@@footnote\footnote
+\def\footnote{\ifx\protect\@typeset@protect
+ \expandafter\FN@sf@@footnote
+ \else
+ \expandafter\FN@sf@gobble@opt
+ \fi
+}
+\edef\FN@sf@gobble@opt{\noexpand\protect
+ \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname}
+\expandafter\def\csname FN@sf@gobble@opt \endcsname{%
+ \@ifnextchar[%]
+ \FN@sf@gobble@twobracket
+ \@gobble
+}
+\def\FN@sf@gobble@twobracket[#1]#2{}
--- /dev/null
+%
+% sphinxhowto.cls for Sphinx (http://sphinx.pocoo.org/)
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)]
+
+% 'oneside' option overriding the 'twoside' default
+\newif\if@oneside
+\DeclareOption{oneside}{\@onesidetrue}
+% Pass remaining document options to the parent class.
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}}
+\ProcessOptions\relax
+
+% Default to two-side document
+\if@oneside
+% nothing to do (oneside is the default)
+\else
+\PassOptionsToClass{twoside}{\sphinxdocclass}
+\fi
+
+\LoadClass{\sphinxdocclass}
+
+% Set some sane defaults for section numbering depth and TOC depth. You can
+% reset these counters in your preamble.
+%
+\setcounter{secnumdepth}{2}
+
+% Change the title page to look a bit better, and fit in with the fncychap
+% ``Bjarne'' style a bit better.
+%
+\renewcommand{\maketitle}{
+ \rule{\textwidth}{1pt}
+ \ifsphinxpdfoutput
+ \begingroup
+ % These \defs are required to deal with multi-line authors; it
+ % changes \\ to ', ' (comma-space), making it pass muster for
+ % generating document info in the PDF file.
+ \def\\{, }
+ \def\and{and }
+ \pdfinfo{
+ /Author (\@author)
+ /Title (\@title)
+ }
+ \endgroup
+ \fi
+ \begin{flushright}
+ \sphinxlogo%
+ {\rm\Huge\py@HeaderFamily \@title} \par
+ {\em\large\py@HeaderFamily \py@release\releaseinfo} \par
+ \vspace{25pt}
+ {\Large\py@HeaderFamily
+ \begin{tabular}[t]{c}
+ \@author
+ \end{tabular}} \par
+ \vspace{25pt}
+ \@date \par
+ \py@authoraddress \par
+ \end{flushright}
+ \@thanks
+ \setcounter{footnote}{0}
+ \let\thanks\relax\let\maketitle\relax
+ %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
+}
+
+\let\py@OldTableofcontents=\tableofcontents
+\renewcommand{\tableofcontents}{
+ \begingroup
+ \parskip = 0mm
+ \py@OldTableofcontents
+ \endgroup
+ \rule{\textwidth}{1pt}
+ \vspace{12pt}
+}
+
+\@ifundefined{fancyhf}{
+ \pagestyle{plain}}{
+ \pagestyle{normal}} % start this way; change for
+\pagenumbering{arabic} % ToC & chapters
+
+\thispagestyle{empty}
+
+% Fix the bibliography environment to add an entry to the Table of
+% Contents.
+% For an article document class this environment is a section,
+% so no page break before it.
+\let\py@OldThebibliography=\thebibliography
+\renewcommand{\thebibliography}[1]{
+ \phantomsection
+ \py@OldThebibliography{1}
+ \addcontentsline{toc}{section}{\bibname}
+}
--- /dev/null
+%
+% sphinxmanual.cls for Sphinx (http://sphinx.pocoo.org/)
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)]
+
+% chapters starting at odd pages (overridden by 'openany' document option)
+\PassOptionsToClass{openright}{\sphinxdocclass}
+
+% 'oneside' option overriding the 'twoside' default
+\newif\if@oneside
+\DeclareOption{oneside}{\@onesidetrue}
+% Pass remaining document options to the parent class.
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}}
+\ProcessOptions\relax
+
+% Defaults two-side document
+\if@oneside
+% nothing to do (oneside is the default)
+\else
+\PassOptionsToClass{twoside}{\sphinxdocclass}
+\fi
+
+\LoadClass{\sphinxdocclass}
+
+% Set some sane defaults for section numbering depth and TOC depth. You can
+% reset these counters in your preamble.
+%
+\setcounter{secnumdepth}{2}
+\setcounter{tocdepth}{1}
+
+% Change the title page to look a bit better, and fit in with the fncychap
+% ``Bjarne'' style a bit better.
+%
+\renewcommand{\maketitle}{%
+ \begin{titlepage}%
+ \let\footnotesize\small
+ \let\footnoterule\relax
+ \rule{\textwidth}{1pt}%
+ \ifsphinxpdfoutput
+ \begingroup
+ % These \defs are required to deal with multi-line authors; it
+ % changes \\ to ', ' (comma-space), making it pass muster for
+ % generating document info in the PDF file.
+ \def\\{, }
+ \def\and{and }
+ \pdfinfo{
+ /Author (\@author)
+ /Title (\@title)
+ }
+ \endgroup
+ \fi
+ \begin{flushright}%
+ \sphinxlogo%
+ {\rm\Huge\py@HeaderFamily \@title \par}%
+ {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par}
+ \vfill
+ {\LARGE\py@HeaderFamily
+ \begin{tabular}[t]{c}
+ \@author
+ \end{tabular}
+ \par}
+ \vfill\vfill
+ {\large
+ \@date \par
+ \vfill
+ \py@authoraddress \par
+ }%
+ \end{flushright}%\par
+ \@thanks
+ \end{titlepage}%
+ \cleardoublepage%
+ \setcounter{footnote}{0}%
+ \let\thanks\relax\let\maketitle\relax
+ %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
+}
+
+
+% Catch the end of the {abstract} environment, but here make sure the abstract
+% is followed by a blank page if the 'openright' option is used.
+%
+\let\py@OldEndAbstract=\endabstract
+\renewcommand{\endabstract}{
+ \if@openright
+ \ifodd\value{page}
+ \typeout{Adding blank page after the abstract.}
+ \vfil\pagebreak
+ \fi
+ \fi
+ \py@OldEndAbstract
+}
+
+% This wraps the \tableofcontents macro with all the magic to get the spacing
+% right and have the right number of pages if the 'openright' option has been
+% used. This eliminates a fair amount of crud in the individual document files.
+%
+\let\py@OldTableofcontents=\tableofcontents
+\renewcommand{\tableofcontents}{%
+ \setcounter{page}{1}%
+ \pagebreak%
+ \pagestyle{plain}%
+ {%
+ \parskip = 0mm%
+ \py@OldTableofcontents%
+ \if@openright%
+ \ifodd\value{page}%
+ \typeout{Adding blank page after the table of contents.}%
+ \pagebreak\hspace{0pt}%
+ \fi%
+ \fi%
+ \cleardoublepage%
+ }%
+ \pagenumbering{arabic}%
+ \@ifundefined{fancyhf}{}{\pagestyle{normal}}%
+}
+
+% This is needed to get the width of the section # area wide enough in the
+% library reference. Doing it here keeps it the same for all the manuals.
+%
+\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}}
+\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}}
+
+% Fix the bibliography environment to add an entry to the Table of
+% Contents.
+% For a report document class this environment is a chapter.
+\let\py@OldThebibliography=\thebibliography
+\renewcommand{\thebibliography}[1]{
+ \cleardoublepage
+ \phantomsection
+ \py@OldThebibliography{1}
+ \addcontentsline{toc}{chapter}{\bibname}
+}
--- /dev/null
+%%
+%% This is file `tabulary.sty',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% tabulary.dtx (with options: `package')
+%% DRAFT VERSION
+%%
+%% File `tabulary.dtx'.
+%% Copyright (C) 1995 1996 2003 David Carlisle
+%% This file may be distributed under the terms of the LPPL.
+%% See 00readme.txt for details.
+%%
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{tabulary}
+ [2007/10/02 v0.9 tabulary package (DPC)]
+\RequirePackage{array}
+\catcode`\Z=14
+\DeclareOption{debugshow}{\catcode`\Z=9\relax}
+\ProcessOptions
+\def\arraybackslash{\let\\=\@arraycr}
+\def\@finalstrut#1{%
+ \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1}
+\newcount\TY@count
+\def\tabulary{%
+ \let\TY@final\tabular
+ \let\endTY@final\endtabular
+ \TY@tabular}
+\def\TY@tabular#1{%
+ \edef\TY@{\@currenvir}%
+ {\ifnum0=`}\fi
+ \@ovxx\TY@linewidth
+ \@ovyy\TY@tablewidth
+ \count@\z@
+ \@tempswatrue
+ \@whilesw\if@tempswa\fi{%
+ \advance\count@\@ne
+ \expandafter\ifx\csname TY@F\the\count@\endcsname\relax
+ \@tempswafalse
+ \else
+ \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname
+ \csname TY@F\the\count@\endcsname
+ \global\expandafter\let\csname TY@F\the\count@\endcsname\relax
+ \expandafter\let\csname TY@S\the\count@\expandafter\endcsname
+ \csname TY@\the\count@\endcsname
+ \fi}%
+ \global\TY@count\@ne
+ \TY@width\xdef{0pt}%
+ \global\TY@tablewidth\z@
+ \global\TY@linewidth#1\relax
+Z\message{^^J^^JTable^^J%
+Z Target Width: \the\TY@linewidth^^J%
+Z \string\tabcolsep: \the\tabcolsep\space
+Z \string\arrayrulewidth: \the\arrayrulewidth\space
+Z \string\doublerulesep: \the\doublerulesep^^J%
+Z \string\tymin: \the\tymin\space
+Z \string\tymax: \the\tymax^^J}%
+ \let\@classz\TY@classz
+ \let\verb\TX@verb
+ \toks@{}\TY@get@body}
+\let\TY@@mkpream\@mkpream
+\def\TY@mkpream{%
+ \def\@addamp{%
+ \if@firstamp \@firstampfalse \else
+ \global\advance\TY@count\@ne
+ \edef\@preamble{\@preamble &}\fi
+ \TY@width\xdef{0pt}}%
+ \def\@acol{%
+ \TY@subwidth\col@sep
+ \@addtopreamble{\hskip\col@sep}}%
+ \let\@arrayrule\TY@arrayrule
+ \let\@classvi\TY@classvi
+ \def\@classv{\save@decl
+ \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@
+ \sbox\z@{\d@llarbegin\@nextchar\d@llarend}%
+ \TY@subwidth{\wd\z@}%
+ \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}%
+ \prepnext@tok}%
+ \global\let\@mkpream\TY@@mkpream
+ \TY@@mkpream}
+\def\TY@arrayrule{%
+ \TY@subwidth\arrayrulewidth
+ \@addtopreamble \vline}
+\def\TY@classvi{\ifcase \@lastchclass
+ \@acol \or
+ \TY@subwidth\doublerulesep
+ \@addtopreamble{\hskip \doublerulesep}\or
+ \@acol \or
+ \@classvii
+ \fi}
+\def\TY@tab{%
+ \setbox\z@\hbox\bgroup
+ \let\[$\let\]$%
+ \let\equation$\let\endequation$%
+ \col@sep\tabcolsep
+ \let\d@llarbegin\begingroup\let\d@llarend\endgroup
+ \let\@mkpream\TY@mkpream
+ \def\multicolumn##1##2##3{\multispan##1\relax}%
+ \CT@start\TY@tabarray}
+\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}}
+\def\TY@array[#1]{\@array[t]}
+\def\TY@width#1{%
+ \expandafter#1\csname TY@\the\TY@count\endcsname}
+\def\TY@subwidth#1{%
+ \TY@width\dimen@
+ \advance\dimen@-#1\relax
+ \TY@width\xdef{\the\dimen@}%
+ \global\advance\TY@linewidth-#1\relax}
+\def\endtabulary{%
+ \gdef\@halignto{}%
+ \let\TY@footnote\footnote%
+ \def\footnote{}% prevent footnotes from doing anything
+ \expandafter\TY@tab\the\toks@
+ \crcr\omit
+ {\xdef\TY@save@row{}%
+ \loop
+ \advance\TY@count\m@ne
+ \ifnum\TY@count>\z@
+ \xdef\TY@save@row{\TY@save@row&\omit}%
+ \repeat}\TY@save@row
+ \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1
+ \unskip\global\setbox1=\lastbox}\egroup
+ \dimen@\TY@linewidth
+ \divide\dimen@\TY@count
+ \ifdim\dimen@<\tymin
+ \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}%
+ \tymin\dimen@
+ \fi
+ \setbox\tw@=\hbox{\unhbox\@ne
+ \loop
+\@tempdima=\lastskip
+\ifdim\@tempdima>\z@
+Z \message{ecs=\the\@tempdima^^J}%
+ \global\advance\TY@linewidth-\@tempdima
+\fi
+ \unskip
+ \setbox\tw@=\lastbox
+ \ifhbox\tw@
+Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}%
+ \ifdim\wd\tw@>\tymax
+ \wd\tw@\tymax
+Z \message{> max\space}%
+Z \else
+Z \message{ \@spaces\space}%
+ \fi
+ \TY@width\dimen@
+Z \message{\the\dimen@\space}%
+ \advance\dimen@\wd\tw@
+Z \message{Final=\the\dimen@\space}%
+ \TY@width\xdef{\the\dimen@}%
+ \ifdim\dimen@<\tymin
+Z \message{< tymin}%
+ \global\advance\TY@linewidth-\dimen@
+ \expandafter\xdef\csname TY@F\the\TY@count\endcsname
+ {\the\dimen@}%
+ \else
+ \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@
+Z \message{***}%
+ \global\advance\TY@linewidth-\dimen@
+ \expandafter\xdef\csname TY@F\the\TY@count\endcsname
+ {\the\dimen@}%
+ \else
+Z \message{> tymin}%
+ \global\advance\TY@tablewidth\dimen@
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname
+ \maxdimen
+ \fi\fi
+ \advance\TY@count\m@ne
+ \repeat}%
+ \TY@checkmin
+ \TY@checkmin
+ \TY@checkmin
+ \TY@checkmin
+ \TY@count\z@
+ \let\TY@box\TY@box@v
+ \let\footnote\TY@footnote % restore footnotes
+ {\expandafter\TY@final\the\toks@\endTY@final}%
+ \count@\z@
+ \@tempswatrue
+ \@whilesw\if@tempswa\fi{%
+ \advance\count@\@ne
+ \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax
+ \@tempswafalse
+ \else
+ \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname
+ \csname TY@SF\the\count@\endcsname
+ \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname
+ \csname TY@S\the\count@\endcsname
+ \fi}%
+ \TY@linewidth\@ovxx
+ \TY@tablewidth\@ovyy
+ \ifnum0=`{\fi}}
+\def\TY@checkmin{%
+ \let\TY@checkmin\relax
+\ifdim\TY@tablewidth>\z@
+ \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth
+ \ifdim\TY@tablewidth <\linewidth
+ \def\TY@ratio{1}%
+ \fi
+\else
+ \TY@warn{No suitable columns!}%
+ \def\TY@ratio{1}%
+\fi
+\count@\z@
+Z \message{^^JLine Width: \the\TY@linewidth,
+Z Natural Width: \the\TY@tablewidth,
+Z Ratio: \TY@ratio^^J}%
+\@tempdima\z@
+\loop
+\ifnum\count@<\TY@count
+\advance\count@\@ne
+ \ifdim\csname TY@F\the\count@\endcsname>\tymin
+ \dimen@\csname TY@\the\count@\endcsname
+ \dimen@\TY@ratio\dimen@
+ \ifdim\dimen@<\tymin
+Z \message{Column \the\count@\space ->}%
+ \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin
+ \global\advance\TY@linewidth-\tymin
+ \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname
+ \let\TY@checkmin\TY@@checkmin
+ \else
+ \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}%
+ \advance\@tempdima\csname TY@F\the\count@\endcsname
+ \fi
+ \fi
+Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }%
+\repeat
+Z \message{^^JTotal:\the\@tempdima^^J}%
+}
+\let\TY@@checkmin\TY@checkmin
+\newdimen\TY@linewidth
+\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}}
+\newdimen\tymin
+\tymin=10pt
+\newdimen\tymax
+\tymax=2\textwidth
+\def\@testpach{\@chclass
+ \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else
+ \ifnum \@lastchclass=7 5 \else
+ \ifnum \@lastchclass=8 \tw@ \else
+ \ifnum \@lastchclass=9 \thr@@
+ \else \z@
+ \ifnum \@lastchclass = 10 \else
+ \edef\@nextchar{\expandafter\string\@nextchar}%
+ \@chnum
+ \if \@nextchar c\z@ \else
+ \if \@nextchar l\@ne \else
+ \if \@nextchar r\tw@ \else
+ \if \@nextchar C7 \else
+ \if \@nextchar L8 \else
+ \if \@nextchar R9 \else
+ \if \@nextchar J10 \else
+ \z@ \@chclass
+ \if\@nextchar |\@ne \else
+ \if \@nextchar !6 \else
+ \if \@nextchar @7 \else
+ \if \@nextchar <8 \else
+ \if \@nextchar >9 \else
+ 10
+ \@chnum
+ \if \@nextchar m\thr@@\else
+ \if \@nextchar p4 \else
+ \if \@nextchar b5 \else
+ \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi
+ \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi}
+\def\TY@classz{%
+ \@classx
+ \@tempcnta\count@
+ \ifx\TY@box\TY@box@v
+ \global\advance\TY@count\@ne
+ \fi
+ \let\centering c%
+ \let\raggedright\noindent
+ \let\raggedleft\indent
+ \let\arraybackslash\relax
+ \prepnext@tok
+ \ifnum\@chnum<4
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \ifnum\@chnum=6
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \@addtopreamble{%
+ \ifcase\@chnum
+ \hfil \d@llarbegin\insert@column\d@llarend \hfil \or
+ \kern\z@
+ \d@llarbegin \insert@column \d@llarend \hfil \or
+ \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or
+ $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
+ \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \d@llarbegin \insert@column \d@llarend \or% dubious "s" case
+ \TY@box\centering\or
+ \TY@box\raggedright\or
+ \TY@box\raggedleft\or
+ \TY@box\relax
+ \fi}\prepnext@tok}
+\def\TY@box#1{%
+ \ifx\centering#1%
+ \hfil \d@llarbegin\insert@column\d@llarend \hfil \else
+ \ifx\raggedright#1%
+ \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+ \d@llarbegin \insert@column \d@llarend \hfil \else
+ \ifx\raggedleft#1%
+ \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else
+ \ifx\relax#1%
+ \d@llarbegin \insert@column \d@llarend
+ \fi \fi \fi \fi}
+\def\TY@box@v#1{%
+ \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}%
+ #1\arraybackslash\tyformat
+ \insert@column\@endpbox}
+\newdimen\TY@tablewidth
+\def\Gscale@div#1#2#3{%
+ \setlength\dimen@{#3}%
+ \ifdim\dimen@=\z@
+ \PackageError{graphics}{Division by 0}\@eha
+ \dimen@#2%
+ \fi
+ \edef\@tempd{\the\dimen@}%
+ \setlength\dimen@{#2}%
+ \count@65536\relax
+ \ifdim\dimen@<\z@
+ \dimen@-\dimen@
+ \count@-\count@
+ \fi
+ \loop
+ \ifdim\dimen@<8192\p@
+ \dimen@\tw@\dimen@
+ \divide\count@\tw@
+ \repeat
+ \dimen@ii=\@tempd\relax
+ \divide\dimen@ii\count@
+ \divide\dimen@\dimen@ii
+ \edef#1{\strip@pt\dimen@}}
+\long\def\TY@get@body#1\end
+ {\toks@\expandafter{\the\toks@#1}\TY@find@end}
+\def\TY@find@end#1{%
+ \def\@tempa{#1}%
+ \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa
+ \else\toks@\expandafter
+ {\the\toks@\end{#1}}\expandafter\TY@get@body\fi}
+\def\TY@warn{%
+ \PackageWarning{tabulary}}
+\catcode`\Z=11
+\AtBeginDocument{
+\@ifpackageloaded{colortbl}{%
+\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1%
+ \expandafter{%
+ \expandafter\let\expandafter\CT@setup\expandafter\relax
+ \expandafter\let\expandafter\CT@color\expandafter\relax
+ \expandafter\let\expandafter\CT@do@color\expandafter\relax
+ \expandafter\let\expandafter\color\expandafter\relax
+ \expandafter\let\expandafter\CT@column@color\expandafter\relax
+ \expandafter\let\expandafter\CT@row@color\expandafter\relax
+ \@mkpream{#1}}
+\let\TY@@mkpream\@mkpream
+\def\TY@classz{%
+ \@classx
+ \@tempcnta\count@
+ \ifx\TY@box\TY@box@v
+ \global\advance\TY@count\@ne
+ \fi
+ \let\centering c%
+ \let\raggedright\noindent
+ \let\raggedleft\indent
+ \let\arraybackslash\relax
+ \prepnext@tok
+\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil
+ \ifnum\@chnum<4
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \ifnum\@chnum=6
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \@addtopreamble{%
+ \setbox\z@\hbox\bgroup\bgroup
+ \ifcase\@chnum
+ \hskip\stretch{.5}\kern\z@
+ \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or
+ \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<
+ \d@llarbegin \insert@column \d@llarend \hfill \or
+ \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or
+ $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
+ \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \d@llarbegin \insert@column \d@llarend \or% dubious s case
+ \TY@box\centering\or
+ \TY@box\raggedright\or
+ \TY@box\raggedleft\or
+ \TY@box\relax
+ \fi
+ \egroup\egroup
+\begingroup
+ \CT@setup
+ \CT@column@color
+ \CT@row@color
+ \CT@do@color
+\endgroup
+ \@tempdima\ht\z@
+ \advance\@tempdima\minrowclearance
+ \vrule\@height\@tempdima\@width\z@
+\unhbox\z@
+}\prepnext@tok}%
+ \def\TY@arrayrule{%
+ \TY@subwidth\arrayrulewidth
+ \@addtopreamble{{\CT@arc@\vline}}}%
+ \def\TY@classvi{\ifcase \@lastchclass
+ \@acol \or
+ \TY@subwidth\doublerulesep
+ \ifx\CT@drsc@\relax
+ \@addtopreamble{\hskip\doublerulesep}%
+ \else
+ \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}%
+ \fi\or
+ \@acol \or
+ \@classvii
+ \fi}%
+}{%
+\let\CT@start\relax
+}
+}
+{\uccode`\*=`\ %
+\uppercase{\gdef\TX@verb{%
+ \leavevmode\null\TX@vwarn
+ {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces
+ \@ifstar{\let~*\TX@vb}{\TX@vb}}}}
+\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}%
+ \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!}
+\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= }
+\begingroup
+\catcode`\*=\catcode`\#
+\catcode`\#=12
+\gdef\TX@vfirst{%
+ \if\@tempa#%
+ \def\@tempb{\TX@v@#}%
+ \else
+ \let\@tempb\TX@v@
+ \if\@tempa\space~\else\@tempa\fi
+ \fi
+ \@tempb}
+\gdef\TX@v@*1 *2{%
+ \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2}
+\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2}
+\endgroup
+\def\TX@vwarn{%
+ \@warning{\noexpand\verb may be unreliable inside tabularx/y}%
+ \global\let\TX@vwarn\@empty}
+\endinput
+%%
+%% End of file `tabulary.sty'.
