test/test_res.html
doc/src/commands/apidoc*
.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
--- /dev/null
+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+# Copyright (C) 2010-2012 CEA/DEN
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+import os
+import src
+
+# Define all possible option for log command : sat doc <options>
+parser = src.options.Options()
+parser.add_option('h', 'html', 'boolean', 'html', "Open sat html documentation in browser", None)
+parser.add_option('p', 'pdf', 'boolean', 'pdf', "Open sat pdf documentation in viewer", False)
+parser.add_option('e', 'edit', 'boolean', 'edit', "edit/modify source dodumentation rst files", False)
+parser.add_option('c', 'compile', 'boolean', 'compile', "how to compile html/pdf doc", False)
+
+def description():
+ """method that is called when salomeTools is called with --help option.
+
+ :return: The text to display for the log command description.
+ :rtype: str
+ """
+ return _("""\
+ Gives access to the sat documentation.
+
+ example:
+ >> sat doc # --html as default
+ >> sat doc --html
+ >> sat doc --pdf""")
+
+def run(args, runner, logger):
+ '''method that is called when salomeTools is called with log parameter.
+ '''
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+
+ # get the log directory.
+ satDir = runner.cfg.VARS.salometoolsway
+ docDir = os.path.join(satDir, "doc")
+ htmlFile = os.path.join(docDir, "build", "html", "index.html")
+ pdfFile = os.path.join(satDir, "doc", "build", "latex", "salomeTools.pdf")
+ rstFiles = os.path.join(satDir, "doc", "src", "*.rst")
+ rstFilesCommands = os.path.join(satDir, "doc", "src", "commands", "*.rst")
+ readmeFile = os.path.join(satDir, "doc", "README")
+
+ logger.write("docdir %s\n" % docDir, 6)
+ logger.write("options %s\n" % options, 6)
+
+ if options.html:
+ src.system.show_in_editor(runner.cfg.USER.browser, htmlFile, logger)
+ if options.pdf:
+ src.system.show_in_editor(runner.cfg.USER.pdf_viewer, pdfFile, logger)
+ if options.edit:
+ src.system.show_in_editor(runner.cfg.USER.editor, rstFiles, logger)
+ src.system.show_in_editor(runner.cfg.USER.editor, rstFilesCommands, logger)
+ if options.compile:
+ logger.write("How to comile documentation:\n%s" % open(readmeFile,"r").read(), 3)
+ return 0
- #!/usr/bin/env python
-#-*- coding:utf-8 -*-
+
LOCAL :
{
base : 'default'
-# needs sphinx-build
-# to make doc html
+# LINUX Compile documentation procedure:
+# needs prerequisite sphinx-build to make doc html
cd doc
make html
make latexpdf
evince build/latex/salomeTools.pdf &
+#########################################################
+# after compilation success do not forget to 'git push' #
+#########################################################
+
<div class="body" role="main">
<h1>All modules for which code is available</h1>
+<ul><li><a href="src.html">src</a></li>
<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/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>
+</ul></ul>
</div>
</div>
--- /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="X-UA-Compatible" content="IE=Edge" />
+ <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" />
+ <script type="text/javascript" src="../_static/documentation_options.js"></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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.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</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1">#-*- coding:utf-8 -*-</span>
+<span class="c1"># Copyright (C) 2010-2013 CEA/DEN</span>
+<span class="c1">#</span>
+<span class="c1"># This library is free software; you can redistribute it and/or</span>
+<span class="c1"># modify it under the terms of the GNU Lesser General Public</span>
+<span class="c1"># License as published by the Free Software Foundation; either</span>
+<span class="c1"># version 2.1 of the License.</span>
+<span class="c1">#</span>
+<span class="c1"># This library is distributed in the hope that it will be useful,</span>
+<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+<span class="c1"># Lesser General Public License for more details.</span>
+<span class="c1">#</span>
+<span class="c1"># You should have received a copy of the GNU Lesser General Public</span>
+<span class="c1"># License along with this library; if not, write to the Free Software</span>
+<span class="c1"># 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="k">import</span> <span class="n">pyconf</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">architecture</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">printcolors</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">options</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">system</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">ElementTree</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">logger</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">product</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">environment</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">fileEnviron</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">compilation</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">test_module</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="k">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="s2">"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="s2">"OK"</span>
+<span class="n">KO_STATUS</span> <span class="o">=</span> <span class="s2">"KO"</span>
+<span class="n">NA_STATUS</span> <span class="o">=</span> <span class="s2">"NA"</span>
+<span class="n">KNOWNFAILURE_STATUS</span> <span class="o">=</span> <span class="s2">"KF"</span>
+<span class="n">TIMEOUT_STATUS</span> <span class="o">=</span> <span class="s2">"TIMEOUT"</span>
+
+<span class="n">CONFIG_FILENAME</span> <span class="o">=</span> <span class="s2">"sat-config.pyconf"</span>
+
+<div class="viewcode-block" id="SatException"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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.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.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="kc">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="s1">'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="s2">"An APPLICATION is required. Use 'config --list' to get"</span>
+ <span class="s2">" the list of available applications.</span><span class="se">\n</span><span class="s2">"</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.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="kc">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="s1">'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="s2">"A profile section is required in your application.</span><span class="se">\n</span><span class="s2">"</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.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="s1">'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.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.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="c1"># 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="c1"># 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="s2">" "</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="s2">"</span><span class="se">\n</span><span class="s2">"</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.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="s2">"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="s2">"data"</span><span class="p">,</span>
+ <span class="s2">"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="s2">"Please define a base path in the file </span><span class="si">%s</span><span class="s2">"</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.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="s1">'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="s1">'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="s1">'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.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="s2">"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="s2">"data"</span><span class="p">,</span>
+ <span class="s2">"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="s2">"Please define a log_dir in the file </span><span class="si">%s</span><span class="s2">"</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.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="s1">'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="s2">"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="s2">"bin"</span><span class="p">,</span>
+ <span class="s2">"salome"</span><span class="p">,</span>
+ <span class="s2">"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="kc">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.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="s1">''</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="s1">'0123456789'</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">'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.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="s2">"Error in configuration file: </span><span class="si">%(file)s</span><span class="se">\n</span><span class="s2"> </span><span class="si">%(error)s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s1">'file'</span><span class="p">:</span> <span class="n">filePath</span><span class="p">,</span> <span class="s1">'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.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></div>
+
+<span class="c1">##</span>
+<span class="c1"># Utils class to simplify path manipulations.</span>
+<div class="viewcode-block" id="Path"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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.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.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.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.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.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.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.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.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="kc">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.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.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.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="kc">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.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="kc">True</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Path.readlink"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="kc">False</span></div>
+
+<div class="viewcode-block" id="Path.symlink"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="kc">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span></div>
+
+<div class="viewcode-block" id="Path.copylink"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="kc">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span></div>
+
+<div class="viewcode-block" id="Path.copydir"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="kc">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="s2">".git"</span><span class="p">,</span> <span class="s2">"CVS"</span><span class="p">,</span> <span class="s2">".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="kc">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span></div>
+
+<div class="viewcode-block" id="Path.copyfile"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="kc">True</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span></div></div>
+
+<div class="viewcode-block" id="find_file_in_lpath"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="s2">""</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="kc">False</span></div>
+
+<div class="viewcode-block" id="handleRemoveReadonly"><a class="viewcode-back" href="../commands/apidoc/src.html#src.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="c1"># 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.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.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.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="s2">"</span><span class="si">%s</span><span class="s2">-</span><span class="si">%s</span><span class="s2">-</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</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.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.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="s2">"_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="s2">"_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="s2">"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="s2">"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.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="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_cfg</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">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="kc">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.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="c1"># Verify the existence of the file</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="s1">'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="s1">'properties'</span><span class="p">,</span> <span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(),</span> <span class="kc">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="s2">"yes"</span></div>
+
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <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" role="search">
+ <h3>Quick search</h3>
+ <div class="searchformwrapper">
+ <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>
+ </div>
+</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.7.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
<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="kc">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="s2">"read"</span><span class="p">):</span>
<span class="c1"># OP TEST</span>
- <span class="nb">print</span> <span class="s2">"iterparse.__init__ source = </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span><span class="n">source</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"iterparse.__init__ source = </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">source</span><span class="p">)</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="s2">"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>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
+ <li><a href="../../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
+ <li><a href="../../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
+ <li><a href="../../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
+ <li><a href="../../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
+ <li><a href="../../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="s2">"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="s2">"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="kc">True</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">verbose_mode</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">if</span> <span class="s2">"verbose"</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">verbose</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">verbose_mode</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1">##</span>
<span class="c1"># Shortcut method to log in log file.</span>
<span class="n">cmake_option</span> <span class="o">+=</span> <span class="s2">" -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="s2">" -DCMAKE_BUILD_TYPE=Release"</span>
-
+
+ <span class="c1"># add verbose option if specified in application for this product.</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose_mode</span><span class="p">:</span>
+ <span class="n">cmake_option</span> <span class="o">+=</span> <span class="s2">" -DCMAKE_VERBOSE_MAKEFILE=ON"</span>
+
<span class="c1"># In case CMAKE_GENERATOR is defined in environment, </span>
<span class="c1"># use it in spite of automatically detect it</span>
<span class="k">if</span> <span class="s1">'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>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<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="s2">"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="c1"># If there is an "environ_script" section, load the scripts</span>
- <span class="k">if</span> <span class="s1">'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="s2">"script </span><span class="si">%s</span><span class="s2">"</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="s2">" "</span><span class="p">,</span> <span class="s2">"_"</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="s2">"APPLICATION_</span><span class="si">%s</span><span class="s2">"</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>
+ <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="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="s2">"_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">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="ow">and</span> <span class="s2">"set_env_build"</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_env_build</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">elif</span> <span class="p">(</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="ow">and</span> <span class="s2">"set_env_launch"</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_env_launch</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="c1"># at least this one is mandatoryi,</span>
+ <span class="c1"># if set_env_build and set_env_build are not defined</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="c1"># not mandatory, if set_nativ_env not defined, we do nothing</span>
<span class="k">if</span> <span class="s2">"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>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<span class="s2"> return</span>
<span class="s2"> # Start SALOME, parsing command line arguments</span>
-<span class="s2"> context.runSalome(args)</span>
-<span class="s2"> #print 'Thank you for using SALOME!'</span>
-
-<span class="s2"> # Logger level info</span>
-<span class="s2"> context.getLogger().setLevel(20)</span>
+<span class="s2"> out, err, status = context.runSalome(args)</span>
+<span class="s2"> sys.exit(status)</span>
<span class="s2"> except SalomeContextException, e:</span>
<span class="s2"> import logging</span>
<span class="s2">#</span>
<span class="s2">"""</span>
+<span class="n">withProfile3</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
+<span class="s2">#! /usr/bin/env python3</span>
+
+<span class="s2">################################################################</span>
+<span class="s2"># WARNING: this file is automatically generated by SalomeTools #</span>
+<span class="s2"># WARNING: and so could be overwritten at any time. #</span>
+<span class="s2">################################################################</span>
+
+<span class="s2">import os</span>
+<span class="s2">import sys</span>
+<span class="s2">import subprocess</span>
+
+
+<span class="s2"># Add the pwdPath to able to run the launcher after unpacking a package</span>
+<span class="s2"># Used only in case of a salomeTools package</span>
+<span class="s2">out_dir_Path=os.path.abspath(os.path.dirname(__file__))</span>
+
+<span class="s2"># Preliminary work to initialize path to SALOME Python modules</span>
+<span class="s2">def __initialize():</span>
+
+<span class="s2"> sys.path[:0] = [ 'BIN_KERNEL_INSTALL_DIR' ]</span>
+<span class="s2"> os.environ['ABSOLUTE_APPLI_PATH'] = 'KERNEL_INSTALL_DIR'</span>
+<span class="s2"> </span>
+<span class="s2"> # define folder to store omniorb config (initially in virtual application folder)</span>
+<span class="s2"> try:</span>
+<span class="s2"> from salomeContextUtils import setOmniOrbUserPath</span>
+<span class="s2"> setOmniOrbUserPath()</span>
+<span class="s2"> except Exception as e:</span>
+<span class="s2"> print(e)</span>
+<span class="s2"> sys.exit(1)</span>
+<span class="s2"># End of preliminary work</span>
+
+<span class="s2"># salome doc only works for virtual applications. Therefore we overwrite it with this function</span>
+<span class="s2">def _showDoc(modules):</span>
+<span class="s2"> for module in modules:</span>
+<span class="s2"> modulePath = os.getenv(module+"_ROOT_DIR")</span>
+<span class="s2"> if modulePath != None:</span>
+<span class="s2"> baseDir = os.path.join(modulePath, "share", "doc", "salome")</span>
+<span class="s2"> docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")</span>
+<span class="s2"> if not os.path.isfile(docfile):</span>
+<span class="s2"> docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")</span>
+<span class="s2"> if not os.path.isfile(docfile):</span>
+<span class="s2"> docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")</span>
+<span class="s2"> if os.path.isfile(docfile):</span>
+<span class="s2"> out, err = subprocess.Popen(["xdg-open", docfile]).communicate()</span>
+<span class="s2"> else:</span>
+<span class="s2"> print("Online documentation is not accessible for module:", module)</span>
+<span class="s2"> else:</span>
+<span class="s2"> print(module+"_ROOT_DIR not found!")</span>
+
+<span class="s2">def main(args):</span>
+<span class="s2"> # Identify application path then locate configuration files</span>
+<span class="s2"> __initialize()</span>
+
+<span class="s2"> if args == ['--help']:</span>
+<span class="s2"> from salomeContext import usage</span>
+<span class="s2"> usage()</span>
+<span class="s2"> sys.exit(0)</span>
+
+<span class="s2"> #from salomeContextUtils import getConfigFileNames</span>
+<span class="s2"> #configFileNames, args, unexisting = getConfigFileNames( args, checkExistence=True )</span>
+<span class="s2"> #if len(unexisting) > 0:</span>
+<span class="s2"> # print("ERROR: unexisting configuration file(s): " + ', '.join(unexisting))</span>
+<span class="s2"> # sys.exit(1)</span>
+
+<span class="s2"> # Create a SalomeContext which parses configFileNames to initialize environment</span>
+<span class="s2"> try:</span>
+<span class="s2"> from salomeContext import SalomeContext, SalomeContextException</span>
+<span class="s2"> SalomeContext.addToSpecial=addToSpecial</span>
+<span class="s2"> context = SalomeContext(None)</span>
+<span class="s2"> </span>
+<span class="s2"> # Here set specific variables, if needed</span>
+<span class="s2"> # context.addToPath('mypath')</span>
+<span class="s2"> # context.addToLdLibraryPath('myldlibrarypath')</span>
+<span class="s2"> # context.addToPythonPath('mypythonpath')</span>
+<span class="s2"> # context.setVariable('myvarname', 'value')</span>
+
+<span class="s2"> # Logger level error</span>
+<span class="s2"> context.getLogger().setLevel(40)</span>
+
+<span class="s2"> context.setVariable(r"PRODUCT_ROOT_DIR", out_dir_Path, overwrite=True)</span>
+<span class="s2"> # here your local standalone environment</span>
+
+<span class="s2"> if len(args) >1 and args[0]=='doc':</span>
+<span class="s2"> _showDoc(args[1:])</span>
+<span class="s2"> return</span>
+
+<span class="s2"> # Start SALOME, parsing command line arguments</span>
+<span class="s2"> out, err, status = context.runSalome(args)</span>
+<span class="s2"> sys.exit(status)</span>
+
+<span class="s2"> except SalomeContextException as e:</span>
+<span class="s2"> import logging</span>
+<span class="s2"> logging.getLogger("salome").error(e)</span>
+<span class="s2"> sys.exit(1)</span>
+<span class="s2">#</span>
+<span class="s2">def addToSpecial(self, name, value, pathSep=None):</span>
+<span class="s2"> # add special dangerous cases: TCLLIBPATH PV_PLUGIN_PATH etc...</span>
+<span class="s2"> # http://computer-programming-forum.com/57-tcl/1dfddc136afccb94.htm</span>
+<span class="s2"> # 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="s2"> if value == '':</span>
+<span class="s2"> return</span>
+<span class="s2"> </span>
+<span class="s2"> specialBlanksKeys=["TCLLIBPATH", "TKLIBPATH"]</span>
+<span class="s2"> specialSemicolonKeys=["PV_PLUGIN_PATH"]</span>
+<span class="s2"> res=os.pathsep</span>
+<span class="s2"> if name in specialBlanksKeys: res=" "</span>
+<span class="s2"> if name in specialSemicolonKeys: res=";"</span>
+<span class="s2"> </span>
+<span class="s2"> if pathSep==None:</span>
+<span class="s2"> sep=res</span>
+<span class="s2"> else:</span>
+<span class="s2"> sep=pathSep</span>
+<span class="s2"> value = os.path.expandvars(value) # expand environment variables</span>
+<span class="s2"> self.getLogger().debug("Add to </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">", name, value)</span>
+<span class="s2"> env = os.getenv(name, None)</span>
+<span class="s2"> if env is None:</span>
+<span class="s2"> os.environ[name] = value</span>
+<span class="s2"> else:</span>
+<span class="s2"> os.environ[name] = value + sep + env #explicitely or not special path separator ?whitespace, semicolon?</span>
+
+<span class="s2">if __name__ == "__main__":</span>
+<span class="s2"> args = sys.argv[1:]</span>
+<span class="s2"> main(args)</span>
+<span class="s2">#</span>
+<span class="s2">"""</span>
+
</pre></div>
</div>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<span class="c1"># You should have received a copy of the GNU Lesser General Public</span>
<span class="c1"># License along with this library; if not, write to the Free Software</span>
<span class="c1"># 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="sd">"""</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">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">printcolors</span>
+<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span> <span class="c1"># Easy print stderr (for DEBUG only)</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="sd">"""</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 to manipulate the options.</span>
+<span class="sd"> </span>
+<span class="sd"> | Example: </span>
+<span class="sd"> | >> options, remainderArgs = command.parseArguments(args)</span>
+<span class="sd"> | >> print(options.output_verbose_level)</span>
+<span class="sd"> | >> 'INFO'</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="sd">"""Initialization</span>
+<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="vm">__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"> 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="sd"> :param name: (str) The attribute to get the value.</span>
+<span class="sd"> :return: (str int list boolean level)</span>
+<span class="sd"> the value corresponding to the attribute.</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="vm">__dict__</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__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="sa">u</span><span class="s2">" is not a valid option"</span><span class="p">))</span>
+ <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="s2">"--"</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="sa">u</span><span class="s2">" 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"> 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="fm">__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="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: None</span>
+<span class="sd"> """</span>
+ <span class="nb">object</span><span class="o">.</span><span class="fm">__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="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">aStr</span> <span class="o">=</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="vm">__dict__</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</span><span class="s2"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">aStr</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">return</span> <span class="n">res</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="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</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="sd">"""Initialization</span>
+<span class="sd"> """</span>
<span class="c1"># The options field stocks all options of a command </span>
<span class="c1"># 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="c1"># 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="s2">"boolean"</span><span class="p">,</span> <span class="s2">"string"</span><span class="p">,</span> <span class="s2">"int"</span><span class="p">,</span> <span class="s2">"float"</span><span class="p">,</span>
- <span class="s2">"long"</span><span class="p">,</span> <span class="s2">"list"</span><span class="p">,</span> <span class="s2">"list2"</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">availableOptions</span> <span class="o">=</span> <span class="s2">"noboolean boolean string int float long list list2 level"</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">noArgOptions</span> <span class="o">=</span> <span class="s2">"noboolean boolean"</span><span class="o">.</span><span class="n">split</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="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">results</span> <span class="o">=</span> <span class="p">{}</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="s2">""</span><span class="p">,</span> <span class="n">default</span> <span class="o">=</span> <span class="kc">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>
+<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="s2">""</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> 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="sd"> :param shortName: (str) </span>
+<span class="sd"> The short name of the option (as '-l' for level option).</span>
+<span class="sd"> :param longName: (str) </span>
+<span class="sd"> The long name of the option (as '--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) </span>
+<span class="sd"> The text to display when user ask for help on a command. </span>
+<span class="sd"> :return: None</span>
+<span class="sd"> """</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="p">[</span><span class="s1">'shortName'</span><span class="p">]</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="k">if</span> <span class="n">o</span><span class="p">[</span><span class="s1">'shortName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">shortName</span> <span class="ow">in</span> <span class="n">tmp</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"option '-</span><span class="si">%s</span><span class="s2">' existing yet"</span> <span class="o">%</span> <span class="n">shortName</span><span class="p">)</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="p">[</span><span class="s1">'longName'</span><span class="p">]</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="k">if</span> <span class="n">o</span><span class="p">[</span><span class="s1">'longName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">longName</span> <span class="ow">in</span> <span class="n">tmp</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"option '--</span><span class="si">%s</span><span class="s2">' existing yet"</span> <span class="o">%</span> <span class="n">longName</span><span class="p">)</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="s1">'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="s1">'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="nb">print</span><span class="p">(</span><span class="s2">"error optionType"</span><span class="p">,</span> <span class="n">optionType</span><span class="p">,</span> <span class="s2">"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="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"error optionType '</span><span class="si">%s</span><span class="s2">' not available."</span> <span class="o">%</span> <span class="n">optionType</span><span class="p">)</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'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="s1">'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="s1">'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="s1">'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.getDetailOption"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.getDetailOption">[docs]</a> <span class="k">def</span> <span class="nf">getDetailOption</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">option</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> for convenience </span>
+<span class="sd"> </span>
+<span class="sd"> :return: (tuple) 4-elements (shortName, longName, optionType, helpString)</span>
+<span class="sd"> """</span>
+ <span class="n">oos</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="s1">'shortName'</span><span class="p">]</span>
+ <span class="n">ool</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="s1">'longName'</span><span class="p">]</span>
+ <span class="n">oot</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="s1">'optionType'</span><span class="p">]</span>
+ <span class="n">ooh</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="s1">'helpString'</span><span class="p">]</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">oos</span><span class="p">,</span> <span class="n">ool</span><span class="p">,</span> <span class="n">oot</span><span class="p">,</span> <span class="n">ooh</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>
+<div class="viewcode-block" id="Options.get_help"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.get_help">[docs]</a> <span class="k">def</span> <span class="nf">get_help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Returns all options stored in self.options </span>
+<span class="sd"> as help message colored string</span>
<span class="sd"> </span>
-<span class="sd"> :return: Nothing.</span>
-<span class="sd"> :rtype: N\A</span>
-<span class="sd"> '''</span>
+<span class="sd"> :return: (str) colored string</span>
+<span class="sd"> """</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">""</span>
<span class="c1"># 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="k">return</span> <span class="n">_</span><span class="p">(</span><span class="s2">"No available options."</span><span class="p">)</span>
- <span class="c1"># for all options, print its values. </span>
- <span class="c1"># "shortname" is an optional field of the options </span>
- <span class="nb">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="s2">"Available options are:"</span><span class="p">)))</span>
+ <span class="c1"># for all options, gets its values. </span>
+ <span class="c1"># "shortname" is an mandatory field of the options, could be '' </span>
+ <span class="n">msg</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="s2">"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="s1">'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="s1">'shortName'</span><span class="p">])</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">" -</span><span class="si">%(shortName)1s</span><span class="s2">, --</span><span class="si">%(longName)s</span><span class="s2">"</span>
- <span class="s2">" (</span><span class="si">%(optionType)s</span><span class="s2">)</span><span class="se">\n\t</span><span class="si">%(helpString)s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">option</span><span class="p">)</span>
+ <span class="n">oos</span><span class="p">,</span> <span class="n">ool</span><span class="p">,</span> <span class="n">oot</span><span class="p">,</span> <span class="n">ooh</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getDetailOption</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">oos</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2"> -</span><span class="si">%1s</span><span class="s2">, --</span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">)</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">oos</span><span class="p">,</span> <span class="n">ool</span><span class="p">,</span> <span class="n">oot</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">" --</span><span class="si">%(longName)s</span><span class="s2"> (</span><span class="si">%(optionType)s</span><span class="s2">)</span><span class="se">\n\t</span><span class="si">%(helpString)s</span><span class="se">\n</span><span class="s2">"</span>
- <span class="o">%</span> <span class="n">option</span><span class="p">)</span></div>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2"> --</span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">)</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ool</span><span class="p">,</span> <span class="n">oot</span><span class="p">)</span>
+
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="p">(</span><span class="n">ooh</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">msg</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">"""</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: None</span>
+<span class="sd"> """</span>
+ <span class="nb">print</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_help</span><span class="p">())</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="Options.indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.indent">[docs]</a> <span class="k">def</span> <span class="nf">indent</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">amount</span><span class="p">,</span> <span class="n">car</span><span class="o">=</span><span class="s2">" "</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">car</span>
+ <span class="k">return</span> <span class="s1">''</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="kc">True</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="kc">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"> 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="sd"> :param argList: (list) the raw list of arguments that were passed</span>
+<span class="sd"> :return: (OptResult, list) as (optResult, args) </span>
+<span class="sd"> optResult is the option instance to manipulate in the code. </span>
+<span class="sd"> args is the full raw list of passed options </span>
+<span class="sd"> """</span>
+ <span class="c1"># see https://pymotw.com/2/getopt/</span>
<span class="k">if</span> <span class="n">argList</span> <span class="ow">is</span> <span class="kc">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="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"parse_args"</span><span class="p">,</span> <span class="n">argList</span><span class="p">)</span>
+ <span class="c1"># DBG.write("options", self.options)</span>
<span class="c1"># format shortNameOption and longNameOption </span>
<span class="c1"># to make right arguments to getopt.getopt function</span>
<span class="n">shortNameOption</span> <span class="o">=</span> <span class="s2">""</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="s1">'shortName'</span><span class="p">]</span>
- <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'shortName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">""</span> <span class="ow">and</span> <span class="n">option</span><span class="p">[</span><span class="s1">'optionType'</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"boolean"</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'shortName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">""</span> <span class="ow">and</span> <span class="n">option</span><span class="p">[</span><span class="s1">'optionType'</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">noArgOptions</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="s2">":"</span>
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'longName'</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">""</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'optionType'</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"boolean"</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'optionType'</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">noArgOptions</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="s1">'longName'</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"="</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="s1">'longName'</span><span class="p">])</span>
<span class="c1"># call to getopt.getopt function to get the option </span>
<span class="c1"># 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="k">try</span><span class="p">:</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="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="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" on '</span><span class="si">%s</span><span class="s2">'</span><span class="se">\n\n</span><span class="s2">"</span> <span class="o">%</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">argList</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_help</span><span class="p">()</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
<span class="c1"># 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">option</span><span class="p">[</span><span class="s1">'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="s2">"boolean"</span><span class="p">:</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s2">"noboolean"</span><span class="p">:</span>
+ <span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">elif</span> <span class="n">optionType</span> <span class="o">==</span> <span class="s2">"int"</span><span class="p">:</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'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="s2">"float"</span><span class="p">:</span>
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'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="s1">'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="s2">"level"</span><span class="p">:</span> <span class="c1">#logger logging levels</span>
+ <span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filterLevel</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="s2">"list2"</span><span class="p">:</span>
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'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="s2">","</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="s1">'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="s2">","</span><span class="p">))</span>
- <span class="n">option</span><span class="p">[</span><span class="s1">'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">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filterList2</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="n">optResult</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="n">option</span><span class="p">[</span><span class="s1">'destName'</span><span class="p">],</span> <span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">])</span>
<span class="c1"># free the option in order to be able to make </span>
<span class="c1"># a new free call of options (API case)</span>
<span class="n">option</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="k">return</span> <span class="n">optResult</span><span class="p">,</span> <span class="n">args</span></div></div>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">results</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"optlist"</span><span class="p">:</span> <span class="n">optlist</span><span class="p">,</span> <span class="s2">"optResult"</span><span class="p">:</span> <span class="n">optResult</span><span class="p">,</span> <span class="s2">"args"</span><span class="p">:</span> <span class="n">args</span><span class="p">,</span> <span class="s2">"argList"</span><span class="p">:</span> <span class="n">argList</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="s2">"results"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">optResult</span><span class="p">,</span> <span class="n">args</span></div>
+
+<div class="viewcode-block" id="Options.filterLevel"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.filterLevel">[docs]</a> <span class="k">def</span> <span class="nf">filterLevel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aLevel</span><span class="p">):</span>
+ <span class="sd">"""filter level logging values"""</span>
+ <span class="kn">import</span> <span class="nn">src.loggingSat</span> <span class="k">as</span> <span class="nn">LOG</span>
+ <span class="n">aLev</span> <span class="o">=</span> <span class="n">aLevel</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
+ <span class="n">knownLevels</span> <span class="o">=</span> <span class="n">LOG</span><span class="o">.</span><span class="n">_knownLevels</span>
+ <span class="n">maxLen</span> <span class="o">=</span> <span class="nb">max</span><span class="p">([</span><span class="nb">len</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">knownLevels</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="n">maxLen</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">lev</span> <span class="ow">in</span> <span class="n">knownLevels</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">aLev</span> <span class="o">==</span> <span class="n">lev</span><span class="p">[:</span><span class="n">i</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="s2">"filterLevel"</span><span class="p">,</span> <span class="s2">"</span><span class="si">%s</span><span class="s2"> -> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">aLevel</span><span class="p">,</span> <span class="n">lev</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">lev</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">"Unknown level '</span><span class="si">%s</span><span class="s2">', accepted are:</span><span class="se">\n</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">aLev</span><span class="p">,</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">knownLevels</span><span class="p">))</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Options.filterList2"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.filterList2">[docs]</a> <span class="k">def</span> <span class="nf">filterList2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aStr</span><span class="p">):</span>
+ <span class="sd">"""filter a list as 'KERNEL,YACS,etc.'"""</span>
+ <span class="n">aList</span> <span class="o">=</span> <span class="n">aStr</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">","</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">aList</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="sd">"""</span>
+<span class="sd"> repr for only self.options and self.results (if present)</span>
+<span class="sd"> """</span>
+ <span class="n">aDict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'options'</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="s1">'results'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="p">}</span>
+ <span class="n">aStr</span> <span class="o">=</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">aDict</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</span><span class="s2"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">aStr</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">return</span> <span class="n">res</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="sd">"""</span>
+<span class="sd"> str for only resume expected self.options</span>
+<span class="sd"> """</span>
+ <span class="c1">#aDict = [(k["longName"], k["shortName", k["helpString"]) for k in self.options}</span>
+ <span class="c1">#aList = [(k, self.options[k]) for k in sorted(self.options.keys())]</span>
+ <span class="n">aDict</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="k">for</span> <span class="n">o</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">aDict</span><span class="p">[</span><span class="n">o</span><span class="p">[</span><span class="s2">"longName"</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(</span><span class="n">o</span><span class="p">[</span><span class="s2">"shortName"</span><span class="p">],</span> <span class="n">o</span><span class="p">[</span><span class="s2">"helpString"</span><span class="p">])</span>
+ <span class="n">aStr</span> <span class="o">=</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">aDict</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</span><span class="s2"> </span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">aStr</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">return</span> <span class="n">res</span>
+
+<div class="viewcode-block" id="Options.debug_write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.options.Options.debug_write">[docs]</a> <span class="k">def</span> <span class="nf">debug_write</span><span class="p">(</span><span class="bp">self</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="s2">"options and results"</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span></div></div>
+
</pre></div>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<span class="c1"># current product </span>
<span class="n">debug</span> <span class="o">=</span> <span class="s1">'no'</span>
<span class="n">dev</span> <span class="o">=</span> <span class="s1">'no'</span>
+ <span class="n">verbose</span> <span class="o">=</span> <span class="s1">'no'</span>
<span class="n">base</span> <span class="o">=</span> <span class="s1">'maybe'</span>
<span class="n">section</span> <span class="o">=</span> <span class="kc">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="k">if</span> <span class="s1">'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="c1"># Get the verbose if any</span>
+ <span class="k">if</span> <span class="s1">'verbose'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
+ <span class="n">verbose</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">verbose</span>
+
<span class="c1"># Get the dev if any</span>
<span class="k">if</span> <span class="s1">'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="c1"># 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">verbose</span> <span class="o">=</span> <span class="n">verbose</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="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="c1">#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="c1">#without path</span>
<span class="c1"># 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="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="c1"># If the product compiles with a script, check the script existence</span>
<span class="c1"># and if it is executable</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">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="s1">'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="s1">'sample'</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">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="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="s1">'yes'</span></div>
+<div class="viewcode-block" id="product_is_verbose"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_verbose">[docs]</a><span class="k">def</span> <span class="nf">product_is_verbose</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">"""Know if a product is in verbose 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 verbose mode, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">verbose</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">verbose</span>
+ <span class="k">return</span> <span class="n">verbose</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'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>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
+ <li><a href="../src.html">src</a><ul>
+ </ul></li>
</ul></li>
</ul></li>
</ul>
-colorama Package
-================
+src.colorama package
+====================
-:mod:`colorama` Package
------------------------
+Submodules
+----------
-.. automodule:: src.colorama
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`ansi` Module
-------------------
+src.colorama.ansi module
+------------------------
.. automodule:: src.colorama.ansi
:members:
:undoc-members:
:show-inheritance:
-:mod:`ansitowin32` Module
--------------------------
+src.colorama.ansitowin32 module
+-------------------------------
.. automodule:: src.colorama.ansitowin32
:members:
:undoc-members:
:show-inheritance:
-:mod:`initialise` Module
-------------------------
+src.colorama.initialise module
+------------------------------
.. automodule:: src.colorama.initialise
:members:
:undoc-members:
:show-inheritance:
-:mod:`win32` Module
--------------------
+src.colorama.win32 module
+-------------------------
.. automodule:: src.colorama.win32
:members:
:undoc-members:
:show-inheritance:
-:mod:`winterm` Module
----------------------
+src.colorama.winterm module
+---------------------------
.. automodule:: src.colorama.winterm
:members:
:undoc-members:
:show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: src.colorama
+ :members:
+ :undoc-members:
+ :show-inheritance:
-src Package
+src package
===========
-:mod:`src` Package
-------------------
+Subpackages
+-----------
-.. automodule:: src.__init__
- :members:
- :undoc-members:
- :show-inheritance:
+.. toctree::
+
+ src.colorama
+
+Submodules
+----------
-:mod:`ElementTree` Module
--------------------------
+src.ElementTree module
+----------------------
.. automodule:: src.ElementTree
:members:
:undoc-members:
:show-inheritance:
-:mod:`architecture` Module
---------------------------
+src.architecture module
+-----------------------
.. automodule:: src.architecture
:members:
:undoc-members:
:show-inheritance:
-:mod:`compilation` Module
--------------------------
+src.compilation module
+----------------------
.. automodule:: src.compilation
:members:
:undoc-members:
:show-inheritance:
-:mod:`debug` Module
--------------------
+src.debug module
+----------------
.. automodule:: src.debug
:members:
:undoc-members:
:show-inheritance:
-:mod:`environment` Module
--------------------------
+src.environment module
+----------------------
.. automodule:: src.environment
:members:
:undoc-members:
:show-inheritance:
-:mod:`fileEnviron` Module
--------------------------
+src.fileEnviron module
+----------------------
.. automodule:: src.fileEnviron
:members:
:undoc-members:
:show-inheritance:
-:mod:`fork` Module
-------------------
+src.fork module
+---------------
.. automodule:: src.fork
:members:
:undoc-members:
:show-inheritance:
-:mod:`logger` Module
---------------------
+src.logger module
+-----------------
.. automodule:: src.logger
:members:
:undoc-members:
:show-inheritance:
-:mod:`options` Module
----------------------
+src.options module
+------------------
.. automodule:: src.options
:members:
:undoc-members:
:show-inheritance:
-:mod:`printcolors` Module
--------------------------
+src.printcolors module
+----------------------
.. automodule:: src.printcolors
:members:
:undoc-members:
:show-inheritance:
-:mod:`product` Module
----------------------
+src.product module
+------------------
.. automodule:: src.product
:members:
:undoc-members:
:show-inheritance:
-:mod:`pyconf` Module
---------------------
+src.pyconf module
+-----------------
.. automodule:: src.pyconf
:members:
:undoc-members:
:show-inheritance:
-:mod:`system` Module
---------------------
+src.system module
+-----------------
.. automodule:: src.system
:members:
:undoc-members:
:show-inheritance:
-:mod:`template` Module
-----------------------
+src.template module
+-------------------
.. automodule:: src.template
:members:
:undoc-members:
:show-inheritance:
-:mod:`test_module` Module
--------------------------
+src.test\_module module
+-----------------------
.. automodule:: src.test_module
:members:
:undoc-members:
:show-inheritance:
-:mod:`xmlManager` Module
-------------------------
+src.xmlManager module
+---------------------
.. automodule:: src.xmlManager
:members:
:undoc-members:
:show-inheritance:
-Subpackages
------------
-
-.. toctree::
- src.colorama
+Module contents
+---------------
+.. automodule:: src
+ :members:
+ :undoc-members:
+ :show-inheritance:
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command doc
+****************
+
+Description
+===========
+The **doc** command displays sat documentation.
+
+Usage
+=====
+* Show (in a web browser) the sat documentation: ::
+
+ sat doc --html
+
+* Show (in evince, for example) the (same) sat documentation in format pdf: ::
+
+ sat doc --pdf
+
+* Edit and modify in your preference user editor the sources files (rst) of sat documentation: ::
+
+ sat doc --edit
+
+* get information how to compile locally sat documentation (from the sources files): ::
+
+ sat doc --compile
+
+
+
+Some useful configuration pathes
+=================================
+
+* **USER**
+
+ * **browser** : The browser used to show the html files (*firefox* for example).
+ * **pdf_viewer** : The viewer used to show the pdf files (*evince* for example).
+ * **editor** : The editor used to edit ascii text files (*pluma or gedit* for example).
+
.. toctree::
:maxdepth: 1
+ doc <commands/doc>
config <commands/config>
prepare <commands/prepare>
compile <commands/compile>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
- <link rel="next" title="src Package" href="src.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" />
<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"><code class="docutils literal notranslate"><span class="pre">src</span></code> Package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.ElementTree"><code class="docutils literal notranslate"><span class="pre">ElementTree</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.architecture"><code class="docutils literal notranslate"><span class="pre">architecture</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.compilation"><code class="docutils literal notranslate"><span class="pre">compilation</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.debug"><code class="docutils literal notranslate"><span class="pre">debug</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.environment"><code class="docutils literal notranslate"><span class="pre">environment</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fileEnviron"><code class="docutils literal notranslate"><span class="pre">fileEnviron</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fork"><code class="docutils literal notranslate"><span class="pre">fork</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.logger"><code class="docutils literal notranslate"><span class="pre">logger</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.options"><code class="docutils literal notranslate"><span class="pre">options</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.printcolors"><code class="docutils literal notranslate"><span class="pre">printcolors</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.product"><code class="docutils literal notranslate"><span class="pre">product</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.pyconf"><code class="docutils literal notranslate"><span class="pre">pyconf</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.system"><code class="docutils literal notranslate"><span class="pre">system</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.template"><code class="docutils literal notranslate"><span class="pre">template</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.test_module"><code class="docutils literal notranslate"><span class="pre">test_module</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.xmlManager"><code class="docutils literal notranslate"><span class="pre">xmlManager</span></code> Module</a></li>
+<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#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"><code class="docutils literal notranslate"><span class="pre">colorama</span></code> Package</a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi"><code class="docutils literal notranslate"><span class="pre">ansi</span></code> Module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32"><code class="docutils literal notranslate"><span class="pre">ansitowin32</span></code> Module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise"><code class="docutils literal notranslate"><span class="pre">initialise</span></code> Module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32"><code class="docutils literal notranslate"><span class="pre">win32</span></code> Module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm"><code class="docutils literal notranslate"><span class="pre">winterm</span></code> Module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.colorama.html">src.colorama package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi">src.colorama.ansi module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise">src.colorama.initialise module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32">src.colorama.win32 module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm">src.colorama.winterm module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.colorama.html#module-src.colorama">Module contents</a></li>
</ul>
</li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.ElementTree">src.ElementTree module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.architecture">src.architecture module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.compilation">src.compilation module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.debug">src.debug module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.environment">src.environment module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fileEnviron">src.fileEnviron module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.fork">src.fork module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.logger">src.logger module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.options">src.options module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.printcolors">src.printcolors module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.product">src.product module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.pyconf">src.pyconf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.system">src.system module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.template">src.template module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.test_module">src.test_module module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.xmlManager">src.xmlManager module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src">Module contents</a></li>
</ul>
</li>
</ul>
<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>
+ <li>Next: <a href="src.html" title="next chapter">src package</a></li>
</ul></li>
</ul>
</div>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>colorama Package — salomeTools 5.0.0dev documentation</title>
+ <title>src.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" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.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="prev" title="src package" href="src.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<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><code class="xref py py-mod docutils literal notranslate"><span class="pre">colorama</span></code> 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="src-colorama-package">
+<h1>src.colorama package<a class="headerlink" href="#src-colorama-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
<div class="section" id="module-src.colorama.ansi">
-<span id="
ansi-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">ansi</span></code> Module<a class="headerlink" href="#module-src.colorama.ansi" title="Permalink to this headline">¶</a></h2>
+<span id="
src-colorama-ansi-module"></span><h2>src.colorama.ansi 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">
</div>
<div class="section" id="module-src.colorama.ansitowin32">
-<span id="
ansitowin32-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">ansitowin32</span></code> Module<a class="headerlink" href="#module-src.colorama.ansitowin32" title="Permalink to this headline">¶</a></h2>
+<span id="
src-colorama-ansitowin32-module"></span><h2>src.colorama.ansitowin32 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><code class="descclassname">src.colorama.ansitowin32.</code><code class="descname">AnsiToWin32</code><span class="sig-paren">(</span><em>wrapped</em>, <em>convert=None</em>, <em>strip=None</em>, <em>autoreset=False</em><span class="sig-paren">)</span><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>
win32 function calls.</p>
<dl class="attribute">
<dt id="src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">
-<code class="descname">ANSI_CSI_RE</code><em class="property"> = <_sre.SRE_Pattern object
at 0x4986ff0></em><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE" title="Permalink to this definition">¶</a></dt>
+<code class="descname">ANSI_CSI_RE</code><em class="property"> = <_sre.SRE_Pattern object></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">
-<code class="descname">ANSI_OSC_RE</code><em class="property"> = <_sre.SRE_Pattern object
at 0x44e4620></em><a class="headerlink" href="#src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE" title="Permalink to this definition">¶</a></dt>
+<code class="descname">ANSI_OSC_RE</code><em class="property"> = <_sre.SRE_Pattern object></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">
</div>
<div class="section" id="module-src.colorama.initialise">
-<span id="
initialise-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">initialise</span></code> Module<a class="headerlink" href="#module-src.colorama.initialise" title="Permalink to this headline">¶</a></h2>
+<span id="
src-colorama-initialise-module"></span><h2>src.colorama.initialise 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">
<code class="descclassname">src.colorama.initialise.</code><code class="descname">colorama_text</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwds</em><span class="sig-paren">)</span><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>
</div>
<div class="section" id="module-src.colorama.win32">
-<span id="
win32-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">win32</span></code> Module<a class="headerlink" href="#module-src.colorama.win32" title="Permalink to this headline">¶</a></h2>
+<span id="
src-colorama-win32-module"></span><h2>src.colorama.win32 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">
<code class="descclassname">src.colorama.win32.</code><code class="descname">SetConsoleTextAttribute</code><span class="sig-paren">(</span><em>*_</em><span class="sig-paren">)</span><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>
</div>
<div class="section" id="module-src.colorama.winterm">
-<span id="
winterm-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">winterm</span></code> Module<a class="headerlink" href="#module-src.colorama.winterm" title="Permalink to this headline">¶</a></h2>
+<span id="
src-colorama-winterm-module"></span><h2>src.colorama.winterm 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><code class="descclassname">src.colorama.winterm.</code><code class="descname">WinColor</code><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></dl>
+</div>
+<div class="section" id="module-src.colorama">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.colorama" title="Permalink to this headline">¶</a></h2>
</div>
</div>
</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"><code class="docutils literal notranslate"><span class="pre">colorama</span></code> Package</a></li>
-<li><a class="reference internal" href="#module-src.colorama.ansi"><code class="docutils literal notranslate"><span class="pre">ansi</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.colorama.ansitowin32"><code class="docutils literal notranslate"><span class="pre">ansitowin32</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.colorama.initialise"><code class="docutils literal notranslate"><span class="pre">initialise</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.colorama.win32"><code class="docutils literal notranslate"><span class="pre">win32</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.colorama.winterm"><code class="docutils literal notranslate"><span class="pre">winterm</span></code> Module</a></li>
+<li><a class="reference internal" href="#">src.colorama package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-src.colorama.ansi">src.colorama.ansi module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.ansitowin32">src.colorama.ansitowin32 module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.initialise">src.colorama.initialise module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.win32">src.colorama.win32 module</a></li>
+<li><a class="reference internal" href="#module-src.colorama.winterm">src.colorama.winterm module</a></li>
+<li><a class="reference internal" href="#module-src.colorama">Module contents</a></li>
</ul>
</li>
</ul>
<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><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>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>src Package — salomeTools 5.0.0dev documentation</title>
+ <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" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
- <link rel="next" title="colorama Package" href="src.colorama.html" />
+ <link rel="next" title="src.colorama package" href="src.colorama.html" />
<link rel="prev" title="src" href="modules.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<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><code class="xref py py-mod docutils literal notranslate"><span class="pre">src</span></code> 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>
+<h1>src package<a class="headerlink" href="#src-package" title="Permalink to this headline">¶</a></h1>
+<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">src.colorama package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi">src.colorama.ansi module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise">src.colorama.initialise module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32">src.colorama.win32 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm">src.colorama.winterm module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-src.ElementTree">
+<span id="src-elementtree-module"></span><h2>src.ElementTree module<a class="headerlink" href="#module-src.ElementTree" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="src.ElementTree.Comment">
+<code class="descclassname">src.ElementTree.</code><code class="descname">Comment</code><span class="sig-paren">(</span><em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Comment" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.dump">
+<code class="descclassname">src.ElementTree.</code><code class="descname">dump</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.dump" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.Element">
+<code class="descclassname">src.ElementTree.</code><code class="descname">Element</code><span class="sig-paren">(</span><em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Element" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
<dl class="class">
-<dt id="src.__init__.Path">
-<em class="property">class </em><code class="descclassname">src.__init__.</code><code class="descname">Path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__init__.html#Path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path" title="Permalink to this definition">¶</a></dt>
+<dt id="src.ElementTree.ElementTree">
+<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">ElementTree</code><span class="sig-paren">(</span><em>element=None</em>, <em>file=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
-<dt id="src.__init__.Path.base">
-<code class="descname">base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dt id="src.ElementTree.ElementTree.find">
+<code class="descname">find</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.find" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.chmod">
-<code class="descname">chmod</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.ElementTree.findall">
+<code class="descname">findall</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findall" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.copy">
-<code class="descname">copy</code><span class="sig-paren">(</span><em>path</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.ElementTree.findtext">
+<code class="descname">findtext</code><span class="sig-paren">(</span><em>path</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findtext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.copydir">
-<code class="descname">copydir</code><span class="sig-paren">(</span><em>dst</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.ElementTree.getiterator">
+<code class="descname">getiterator</code><span class="sig-paren">(</span><em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getiterator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getiterator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.copyfile">
-<code class="descname">copyfile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.ElementTree.getroot">
+<code class="descname">getroot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getroot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getroot" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.copylink">
-<code class="descname">copylink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.ElementTree.parse">
+<code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.dir">
-<code class="descname">dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dt id="src.ElementTree.ElementTree.write">
+<code class="descname">write</code><span class="sig-paren">(</span><em>file</em>, <em>encoding='us-ascii'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.write" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.exists">
-<code class="descname">exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.fromstring">
+<code class="descclassname">src.ElementTree.</code><code class="descname">fromstring</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.isdir">
-<code class="descname">isdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dl class="function">
+<dt id="src.ElementTree.iselement">
+<code class="descclassname">src.ElementTree.</code><code class="descname">iselement</code><span class="sig-paren">(</span><em>element</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iselement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iselement" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.isfile">
-<code class="descname">isfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dl class="class">
+<dt id="src.ElementTree.iterparse">
+<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">iterparse</code><span class="sig-paren">(</span><em>source</em>, <em>events=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="method">
+<dt id="src.ElementTree.iterparse.next">
+<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse.next" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.islink">
-<code class="descname">islink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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></dl>
+
+<dl class="function">
+<dt id="src.ElementTree.parse">
+<code class="descclassname">src.ElementTree.</code><code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.list">
-<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dl class="function">
+<dt id="src.ElementTree.PI">
+<code class="descclassname">src.ElementTree.</code><code class="descname">PI</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.PI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.make">
-<code class="descname">make</code><span class="sig-paren">(</span><em>mode=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dl class="function">
+<dt id="src.ElementTree.ProcessingInstruction">
+<code class="descclassname">src.ElementTree.</code><code class="descname">ProcessingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ProcessingInstruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ProcessingInstruction" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.readlink">
-<code class="descname">readlink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dl class="class">
+<dt id="src.ElementTree.QName">
+<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">QName</code><span class="sig-paren">(</span><em>text_or_uri</em>, <em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#QName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.QName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.rm">
-<code class="descname">rm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
+<dl class="function">
+<dt id="src.ElementTree.SubElement">
+<code class="descclassname">src.ElementTree.</code><code class="descname">SubElement</code><span class="sig-paren">(</span><em>parent</em>, <em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#SubElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.SubElement" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.__init__.Path.smartcopy">
-<code class="descname">smartcopy</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dl class="function">
+<dt id="src.ElementTree.tostring">
+<code class="descclassname">src.ElementTree.</code><code class="descname">tostring</code><span class="sig-paren">(</span><em>element</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#tostring"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.tostring" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="class">
+<dt id="src.ElementTree.TreeBuilder">
+<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">TreeBuilder</code><span class="sig-paren">(</span><em>element_factory=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="method">
+<dt id="src.ElementTree.TreeBuilder.close">
+<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.close" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.__init__.Path.symlink">
-<code class="descname">symlink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.TreeBuilder.data">
+<code class="descname">data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.ElementTree.TreeBuilder.end">
+<code class="descname">end</code><span class="sig-paren">(</span><em>tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.end" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="exception">
-<dt id="src.__init__.SatException">
-<em class="property">exception </em><code class="descclassname">src.__init__.</code><code class="descname">SatException</code><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: <code class="xref py py-class docutils literal notranslate"><span class="pre">exceptions.Exception</span></code></p>
-<p>rename Exception Class</p>
-</dd></dl>
+<dl class="method">
+<dt id="src.ElementTree.TreeBuilder.start">
+<code class="descname">start</code><span class="sig-paren">(</span><em>tag</em>, <em>attrs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.start" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="function">
-<dt id="src.__init__.activate_mesa_property">
-<code class="descclassname">src.__init__.</code><code class="descname">activate_mesa_property</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">check_config_has_application</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.ElementTree.XML">
+<code class="descclassname">src.ElementTree.</code><code class="descname">XML</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XML"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XML" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="function">
-<dt id="src.__init__.check_config_has_profile">
-<code class="descclassname">src.__init__.</code><code class="descname">check_config_has_profile</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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="class">
+<dt id="src.ElementTree.XMLTreeBuilder">
+<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">XMLTreeBuilder</code><span class="sig-paren">(</span><em>html=0</em>, <em>target=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="method">
+<dt id="src.ElementTree.XMLTreeBuilder.close">
+<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.close" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="function">
-<dt id="src.__init__.config_has_application">
-<code class="descclassname">src.__init__.</code><code class="descname">config_has_application</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dl class="method">
+<dt id="src.ElementTree.XMLTreeBuilder.doctype">
+<code class="descname">doctype</code><span class="sig-paren">(</span><em>name</em>, <em>pubid</em>, <em>system</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.doctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.doctype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="function">
-<dt id="src.__init__.deepcopy_list">
-<code class="descclassname">src.__init__.</code><code class="descname">deepcopy_list</code><span class="sig-paren">(</span><em>input_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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="method">
+<dt id="src.ElementTree.XMLTreeBuilder.feed">
+<code class="descname">feed</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.feed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.feed" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="function">
-<dt id="src.__init__.ensure_path_exists">
-<code class="descclassname">src.__init__.</code><code class="descname">ensure_path_exists</code><span class="sig-paren">(</span><em>p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+</div>
+<div class="section" id="module-src.architecture">
+<span id="src-architecture-module"></span><h2>src.architecture 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.__init__.find_file_in_lpath">
-<code class="descclassname">src.__init__.</code><code class="descname">find_file_in_lpath</code><span class="sig-paren">(</span><em>file_name</em>, <em>lpath</em>, <em>additional_dir=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.get_distrib_version">
+<code class="descclassname">src.architecture.</code><code class="descname">get_distrib_version</code><span class="sig-paren">(</span><em>distrib</em>, <em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distrib_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distrib_version" title="Permalink to this definition">¶</a></dt>
+<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>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>
+<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 full path of the file or False if not found</p>
+<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>
</dd></dl>
<dl class="function">
-<dt id="src.__init__.get_base_path">
-<code class="descclassname">src.__init__.</code><code class="descname">get_base_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.get_distribution">
+<code class="descclassname">src.architecture.</code><code class="descname">get_distribution</code><span class="sig-paren">(</span><em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distribution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distribution" title="Permalink to this definition">¶</a></dt>
+<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>Config</strong> (<em>config</em>) – The global Config instance.</td>
+<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 path of the products base.</td>
+<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>
</dd></dl>
<dl class="function">
-<dt id="src.__init__.get_cfg_param">
-<code class="descclassname">src.__init__.</code><code class="descname">get_cfg_param</code><span class="sig-paren">(</span><em>config</em>, <em>param_name</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.get_nb_proc">
+<code class="descclassname">src.architecture.</code><code class="descname">get_nb_proc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_nb_proc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_nb_proc" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Gets the number of processors of the machine </dt>
+<dd>on which salomeTools is running.</dd>
+</dl>
<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 class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processors.</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 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.__init__.get_launcher_name">
-<code class="descclassname">src.__init__.</code><code class="descname">get_launcher_name</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.get_python_version">
+<code class="descclassname">src.architecture.</code><code class="descname">get_python_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_python_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_python_version" title="Permalink to this definition">¶</a></dt>
+<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">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 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-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+<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.__init__.get_log_path">
-<code class="descclassname">src.__init__.</code><code class="descname">get_log_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.get_user">
+<code class="descclassname">src.architecture.</code><code class="descname">get_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_user" title="Permalink to this definition">¶</a></dt>
+<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">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>
</dd></dl>
<dl class="function">
-<dt id="src.__init__.get_property_in_product_cfg">
-<code class="descclassname">src.__init__.</code><code class="descname">get_property_in_product_cfg</code><span class="sig-paren">(</span><em>product_cfg</em>, <em>pprty</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">get_salome_version</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">get_tmp_filename</code><span class="sig-paren">(</span><em>cfg</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">handleRemoveReadonly</code><span class="sig-paren">(</span><em>func</em>, <em>path</em>, <em>exc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">merge_dicts</code><span class="sig-paren">(</span><em>*dict_args</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">only_numbers</code><span class="sig-paren">(</span><em>str_num</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">parse_date</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">print_info</code><span class="sig-paren">(</span><em>logger</em>, <em>info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">read_config_from_a_file</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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">
-<code class="descclassname">src.__init__.</code><code class="descname">remove_item_from_list</code><span class="sig-paren">(</span><em>input_list</em>, <em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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>
+<dt id="src.architecture.is_windows">
+<code class="descclassname">src.architecture.</code><code class="descname">is_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#is_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.is_windows" title="Permalink to this definition">¶</a></dt>
+<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">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 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.__init__.replace_in_file">
-<code class="descclassname">src.__init__.</code><code class="descname">replace_in_file</code><span class="sig-paren">(</span><em>filein</em>, <em>strin</em>, <em>strout</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/__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><code class="xref py py-mod docutils literal notranslate"><span class="pre">ElementTree</span></code> Module<a class="headerlink" href="#module-src.ElementTree" title="Permalink to this headline">¶</a></h2>
-<dl class="function">
-<dt id="src.ElementTree.Comment">
-<code class="descclassname">src.ElementTree.</code><code class="descname">Comment</code><span class="sig-paren">(</span><em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Comment" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.dump">
-<code class="descclassname">src.ElementTree.</code><code class="descname">dump</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.dump" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.Element">
-<code class="descclassname">src.ElementTree.</code><code class="descname">Element</code><span class="sig-paren">(</span><em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Element" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
+<div class="section" id="module-src.compilation">
+<span id="src-compilation-module"></span><h2>src.compilation module<a class="headerlink" href="#module-src.compilation" title="Permalink to this headline">¶</a></h2>
<dl class="class">
-<dt id="src.ElementTree.ElementTree">
-<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">ElementTree</code><span class="sig-paren">(</span><em>element=None</em>, <em>file=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
-<dt id="src.ElementTree.ElementTree.find">
-<code class="descname">find</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.find" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
+<dt id="src.compilation.Builder">
+<em class="property">class </em><code class="descclassname">src.compilation.</code><code class="descname">Builder</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>product_info</em>, <em>options=OptResult( )</em>, <em>check_src=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class to handle all construction steps, like cmake, configure, make, …</p>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.findall">
-<code class="descname">findall</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findall" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.build_configure">
+<code class="descname">build_configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.build_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.build_configure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.findtext">
-<code class="descname">findtext</code><span class="sig-paren">(</span><em>path</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findtext" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.check">
+<code class="descname">check</code><span class="sig-paren">(</span><em>command=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.check" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.getiterator">
-<code class="descname">getiterator</code><span class="sig-paren">(</span><em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getiterator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getiterator" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.cmake">
+<code class="descname">cmake</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.cmake" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.getroot">
-<code class="descname">getroot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getroot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getroot" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.complete_environment">
+<code class="descname">complete_environment</code><span class="sig-paren">(</span><em>make_options</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.complete_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.complete_environment" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.parse">
-<code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.configure">
+<code class="descname">configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.configure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.ElementTree.write">
-<code class="descname">write</code><span class="sig-paren">(</span><em>file</em>, <em>encoding='us-ascii'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.write" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.fromstring">
-<code class="descclassname">src.ElementTree.</code><code class="descname">fromstring</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.iselement">
-<code class="descclassname">src.ElementTree.</code><code class="descname">iselement</code><span class="sig-paren">(</span><em>element</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iselement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iselement" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="class">
-<dt id="src.ElementTree.iterparse">
-<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">iterparse</code><span class="sig-paren">(</span><em>source</em>, <em>events=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
-<dt id="src.ElementTree.iterparse.next">
-<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse.next" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.parse">
-<code class="descclassname">src.ElementTree.</code><code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.PI">
-<code class="descclassname">src.ElementTree.</code><code class="descname">PI</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.PI" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.ProcessingInstruction">
-<code class="descclassname">src.ElementTree.</code><code class="descname">ProcessingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ProcessingInstruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ProcessingInstruction" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="class">
-<dt id="src.ElementTree.QName">
-<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">QName</code><span class="sig-paren">(</span><em>text_or_uri</em>, <em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#QName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.QName" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.SubElement">
-<code class="descclassname">src.ElementTree.</code><code class="descname">SubElement</code><span class="sig-paren">(</span><em>parent</em>, <em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#SubElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.SubElement" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.do_batch_script_build">
+<code class="descname">do_batch_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_batch_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_batch_script_build" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="function">
-<dt id="src.ElementTree.tostring">
-<code class="descclassname">src.ElementTree.</code><code class="descname">tostring</code><span class="sig-paren">(</span><em>element</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#tostring"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.tostring" title="Permalink to this definition">¶</a></dt>
+<dl class="method">
+<dt id="src.compilation.Builder.do_default_build">
+<code class="descname">do_default_build</code><span class="sig-paren">(</span><em>build_conf_options=''</em>, <em>configure_options=''</em>, <em>show_warning=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_default_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_default_build" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="class">
-<dt id="src.ElementTree.TreeBuilder">
-<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">TreeBuilder</code><span class="sig-paren">(</span><em>element_factory=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
-<dt id="src.ElementTree.TreeBuilder.close">
-<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.close" title="Permalink to this definition">¶</a></dt>
+<dl class="method">
+<dt id="src.compilation.Builder.do_python_script_build">
+<code class="descname">do_python_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_python_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_python_script_build" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.TreeBuilder.data">
-<code class="descname">data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.data" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.do_script_build">
+<code class="descname">do_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>number_of_proc=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_script_build" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.TreeBuilder.end">
-<code class="descname">end</code><span class="sig-paren">(</span><em>tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.end" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.hack_libtool">
+<code class="descname">hack_libtool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.hack_libtool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.hack_libtool" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.TreeBuilder.start">
-<code class="descname">start</code><span class="sig-paren">(</span><em>tag</em>, <em>attrs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.start" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.install">
+<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.install"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.install" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</dd></dl>
-
-<dl class="function">
-<dt id="src.ElementTree.XML">
-<code class="descclassname">src.ElementTree.</code><code class="descname">XML</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XML"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XML" title="Permalink to this definition">¶</a></dt>
+<dl class="method">
+<dt id="src.compilation.Builder.log">
+<code class="descname">log</code><span class="sig-paren">(</span><em>text</em>, <em>level</em>, <em>showInfo=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="class">
-<dt id="src.ElementTree.XMLTreeBuilder">
-<em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">XMLTreeBuilder</code><span class="sig-paren">(</span><em>html=0</em>, <em>target=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
-<dt id="src.ElementTree.XMLTreeBuilder.close">
-<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.close" title="Permalink to this definition">¶</a></dt>
+<dl class="method">
+<dt id="src.compilation.Builder.log_command">
+<code class="descname">log_command</code><span class="sig-paren">(</span><em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log_command" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.XMLTreeBuilder.doctype">
-<code class="descname">doctype</code><span class="sig-paren">(</span><em>name</em>, <em>pubid</em>, <em>system</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.doctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.doctype" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.make">
+<code class="descname">make</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>make_opt=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.make" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.ElementTree.XMLTreeBuilder.feed">
-<code class="descname">feed</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.feed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.feed" title="Permalink to this definition">¶</a></dt>
+<dt id="src.compilation.Builder.prepare">
+<code class="descname">prepare</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.prepare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.prepare" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</dd></dl>
-
-</div>
-<div class="section" id="module-src.architecture">
-<span id="architecture-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">architecture</span></code> 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">
-<code class="descclassname">src.architecture.</code><code class="descname">get_distrib_version</code><span class="sig-paren">(</span><em>distrib</em>, <em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distrib_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distrib_version" title="Permalink to this definition">¶</a></dt>
-<dd><p>Gets the version of the distribution</p>
+<dl class="method">
+<dt id="src.compilation.Builder.put_txt_log_in_appli_log_dir">
+<code class="descname">put_txt_log_in_appli_log_dir</code><span class="sig-paren">(</span><em>file_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.put_txt_log_in_appli_log_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.put_txt_log_in_appli_log_dir" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Put the txt log (that contain the system logs, like make command</dt>
+<dd>output) in the directory <APPLICATION DIR>/LOGS/<product_name>/</dd>
+</dl>
<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">
-<code class="descclassname">src.architecture.</code><code class="descname">get_distribution</code><span class="sig-paren">(</span><em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distribution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distribution" title="Permalink to this definition">¶</a></dt>
-<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">
-<code class="descclassname">src.architecture.</code><code class="descname">get_nb_proc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_nb_proc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_nb_proc" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Gets the number of processors of the machine </dt>
-<dd>on which salomeTools is running.</dd>
-</dl>
-<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">
-<code class="descclassname">src.architecture.</code><code class="descname">get_python_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_python_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_python_version" title="Permalink to this definition">¶</a></dt>
-<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">
-<code class="descclassname">src.architecture.</code><code class="descname">get_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_user" title="Permalink to this definition">¶</a></dt>
-<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">
-<code class="descclassname">src.architecture.</code><code class="descname">is_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#is_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.is_windows" title="Permalink to this definition">¶</a></dt>
-<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><code class="xref py py-mod docutils literal notranslate"><span class="pre">compilation</span></code> 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><code class="descclassname">src.compilation.</code><code class="descname">Builder</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>product_info</em>, <em>options=<src.options.OptResult object at 0x37b8f90></em>, <em>check_src=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class to handle all construction steps, like cmake, configure, make, …</p>
-<dl class="method">
-<dt id="src.compilation.Builder.build_configure">
-<code class="descname">build_configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.build_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.build_configure" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.check">
-<code class="descname">check</code><span class="sig-paren">(</span><em>command=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.check" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.cmake">
-<code class="descname">cmake</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.cmake" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.complete_environment">
-<code class="descname">complete_environment</code><span class="sig-paren">(</span><em>make_options</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.complete_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.complete_environment" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.configure">
-<code class="descname">configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.configure" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.do_batch_script_build">
-<code class="descname">do_batch_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_batch_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_batch_script_build" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.do_default_build">
-<code class="descname">do_default_build</code><span class="sig-paren">(</span><em>build_conf_options=''</em>, <em>configure_options=''</em>, <em>show_warning=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_default_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_default_build" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.do_python_script_build">
-<code class="descname">do_python_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_python_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_python_script_build" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.do_script_build">
-<code class="descname">do_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>number_of_proc=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_script_build" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.hack_libtool">
-<code class="descname">hack_libtool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.hack_libtool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.hack_libtool" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.install">
-<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.install"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.install" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.log">
-<code class="descname">log</code><span class="sig-paren">(</span><em>text</em>, <em>level</em>, <em>showInfo=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.log_command">
-<code class="descname">log_command</code><span class="sig-paren">(</span><em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log_command" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.make">
-<code class="descname">make</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>make_opt=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.make" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.prepare">
-<code class="descname">prepare</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.prepare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.prepare" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="src.compilation.Builder.put_txt_log_in_appli_log_dir">
-<code class="descname">put_txt_log_in_appli_log_dir</code><span class="sig-paren">(</span><em>file_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.put_txt_log_in_appli_log_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.put_txt_log_in_appli_log_dir" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Put the txt log (that contain the system logs, like make command</dt>
-<dd>output) in the directory <APPLICATION DIR>/LOGS/<product_name>/</dd>
-</dl>
-<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 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>
</div>
<div class="section" id="module-src.debug">
-<span id="
debug-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">debug</span></code> Module<a class="headerlink" href="#module-src.debug" title="Permalink to this headline">¶</a></h2>
+<span id="
src-debug-module"></span><h2>src.debug 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>
</div>
<div class="section" id="module-src.environment">
-<span id="
environment-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">environment</span></code> Module<a class="headerlink" href="#module-src.environment" title="Permalink to this headline">¶</a></h2>
+<span id="
src-environment-module"></span><h2>src.environment 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><code class="descclassname">src.environment.</code><code class="descname">Environ</code><span class="sig-paren">(</span><em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ" title="Permalink to this definition">¶</a></dt>
</div>
<div class="section" id="module-src.fileEnviron">
-<span id="
fileenviron-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileEnviron</span></code> Module<a class="headerlink" href="#module-src.fileEnviron" title="Permalink to this headline">¶</a></h2>
+<span id="
src-fileenviron-module"></span><h2>src.fileEnviron 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><code class="descclassname">src.fileEnviron.</code><code class="descname">BashFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron" title="Permalink to this definition">¶</a></dt>
</div>
<div class="section" id="module-src.fork">
-<span id="
fork-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">fork</span></code> Module<a class="headerlink" href="#module-src.fork" title="Permalink to this headline">¶</a></h2>
+<span id="
src-fork-module"></span><h2>src.fork module<a class="headerlink" href="#module-src.fork" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="src.fork.batch">
<code class="descclassname">src.fork.</code><code class="descname">batch</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=[]</em>, <em>log=None</em>, <em>delai=20</em>, <em>sommeil=1</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.batch" title="Permalink to this definition">¶</a></dt>
</div>
<div class="section" id="module-src.logger">
-<span id="
logger-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">logger</span></code> Module<a class="headerlink" href="#module-src.logger" title="Permalink to this headline">¶</a></h2>
+<span id="
src-logger-module"></span><h2>src.logger 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">
</div>
<div class="section" id="module-src.options">
-<span id="
options-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">options</span></code> Module<a class="headerlink" href="#module-src.options" title="Permalink to this headline">¶</a></h2>
+<span id="
src-options-module"></span><h2>src.options 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">
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></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>
+The aim of this class is to have an elegant syntax to manipulate the options.</p>
+<div class="line-block">
+<div class="line">Example: </div>
+<div class="line">>> options, remainderArgs = command.parseArguments(args)</div>
+<div class="line">>> print(options.output_verbose_level)</div>
+<div class="line">>> ‘INFO’</div>
+</div>
</dd></dl>
<dl class="class">
<dt id="src.options.Options">
<em class="property">class </em><code class="descclassname">src.options.</code><code class="descname">Options</code><a class="reference internal" href="../../_modules/src/options.html#Options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class to manage all salomeTools options</p>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Class to manage all salomeTools options</p>
<dl class="method">
<dt id="src.options.Options.add_option">
<code class="descname">add_option</code><span class="sig-paren">(</span><em>shortName</em>, <em>longName</em>, <em>optionType</em>, <em>destName</em>, <em>helpString=''</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.add_option"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.add_option" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Method to add an option to a command. It gets all attributes</dt>
-<dd>of an option and append it in the options field</dd>
-</dl>
+<dd><p>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>
+<li><strong>shortName</strong> – (str)
+The short name of the option (as ‘-l’ for level option).</li>
+<li><strong>longName</strong> – (str)
+The long name of the option (as ‘–level’ for level option).</li>
+<li><strong>optionType</strong> – (str) The type of the option (ex “int”).</li>
+<li><strong>destName</strong> – (str) The name that will be used in the code.</li>
+<li><strong>helpString</strong> – (str)
+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>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</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>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.debug_write">
+<code class="descname">debug_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.debug_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.debug_write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.filterLevel">
+<code class="descname">filterLevel</code><span class="sig-paren">(</span><em>aLevel</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.filterLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.filterLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>filter level logging values</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.filterList2">
+<code class="descname">filterList2</code><span class="sig-paren">(</span><em>aStr</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.filterList2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.filterList2" title="Permalink to this definition">¶</a></dt>
+<dd><p>filter a list as ‘KERNEL,YACS,etc.’</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.getDetailOption">
+<code class="descname">getDetailOption</code><span class="sig-paren">(</span><em>option</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.getDetailOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.getDetailOption" title="Permalink to this definition">¶</a></dt>
+<dd><p>for convenience</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">(tuple) 4-elements (shortName, longName, optionType, helpString)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.options.Options.get_help">
+<code class="descname">get_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.get_help" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns all options stored in self.options
+as help message colored string</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">(str) colored string</td>
</tr>
</tbody>
</table>
</dd></dl>
+<dl class="method">
+<dt id="src.options.Options.indent">
+<code class="descname">indent</code><span class="sig-paren">(</span><em>text</em>, <em>amount</em>, <em>car=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.indent" title="Permalink to this definition">¶</a></dt>
+<dd><p>indent multi lines message</p>
+</dd></dl>
+
<dl class="method">
<dt id="src.options.Options.parse_args">
<code class="descname">parse_args</code><span class="sig-paren">(</span><em>argList=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.parse_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.parse_args" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Method that instantiates the class OptResult </dt>
-<dd>that gives access to all options in the code</dd>
-</dl>
+<dd><p>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 class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>argList</strong> – (list) the raw list of arguments that were passed</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(class ‘common.options.OptResult’,list)</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(OptResult, list) as (optResult, args)
+optResult is the option instance to manipulate in the code.
+args is the full raw list of passed options</td>
</tr>
</tbody>
</table>
<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 class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="module-src.printcolors">
-<span id="
printcolors-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">printcolors</span></code> Module<a class="headerlink" href="#module-src.printcolors" title="Permalink to this headline">¶</a></h2>
+<span id="
src-printcolors-module"></span><h2>src.printcolors 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">
</div>
<div class="section" id="module-src.product">
-<span id="
product-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">product</span></code> Module<a class="headerlink" href="#module-src.product" title="Permalink to this headline">¶</a></h2>
+<span id="
src-product-module"></span><h2>src.product 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">
</dd></dl>
<dl class="function">
-<dt id="src.product.product_is_sample">
-<code class="descclassname">src.product.</code><code class="descname">product_is_sample</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_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>
+<dt id="src.product.product_is_smesh_plugin">
+<code class="descclassname">src.product.</code><code class="descname">product_is_smesh_plugin</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_smesh_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_smesh_plugin" title="Permalink to this definition">¶</a></dt>
+<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" />
<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 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>
</dd></dl>
<dl class="function">
-<dt id="src.product.product_is_smesh_plugin">
-<code class="descclassname">src.product.</code><code class="descname">product_is_smesh_plugin</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_smesh_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_smesh_plugin" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is a SMESH plugin</p>
+<dt id="src.product.product_is_vcs">
+<code class="descclassname">src.product.</code><code class="descname">product_is_vcs</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_vcs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_vcs" title="Permalink to this definition">¶</a></dt>
+<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" />
<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 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>
</dd></dl>
<dl class="function">
-<dt id="src.product.product_is_vcs">
-<code class="descclassname">src.product.</code><code class="descname">product_is_vcs</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_vcs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_vcs" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is download using git, svn or cvs (not archive)</p>
+<dt id="src.product.product_is_verbose">
+<code class="descclassname">src.product.</code><code class="descname">product_is_verbose</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_verbose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_verbose" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is in verbose mode</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<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 class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in verbose mode, else False</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</div>
<div class="section" id="module-src.pyconf">
-<span id="
pyconf-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyconf</span></code> Module<a class="headerlink" href="#module-src.pyconf" title="Permalink to this headline">¶</a></h2>
+<span id="
src-pyconf-module"></span><h2>src.pyconf 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>
<dl class="class">
<dt id="src.pyconf.ConfigMerger">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigMerger</code><span class="sig-paren">(</span><em>resolver=<function defaultMergeResolve
at 0x36fa5f0></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigMerger</code><span class="sig-paren">(</span><em>resolver=<function defaultMergeResolve></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></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
@rtype: str</p>
</dd></dl>
-<dl class="function">
-<dt id="src.pyconf.overwriteMergeResolve">
-<code class="descclassname">src.pyconf.</code><code class="descname">overwriteMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#overwriteMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.overwriteMergeResolve" title="Permalink to this definition">¶</a></dt>
-<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>
+<dl class="function">
+<dt id="src.pyconf.overwriteMergeResolve">
+<code class="descclassname">src.pyconf.</code><code class="descname">overwriteMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#overwriteMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.overwriteMergeResolve" title="Permalink to this definition">¶</a></dt>
+<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="src-system-module"></span><h2>src.system 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">
+<code class="descclassname">src.system.</code><code class="descname">archive_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>where</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#archive_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.archive_extract" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descclassname">src.system.</code><code class="descname">cvs_extract</code><span class="sig-paren">(</span><em>protocol</em>, <em>user</em>, <em>server</em>, <em>base</em>, <em>tag</em>, <em>product</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#cvs_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.cvs_extract" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descclassname">src.system.</code><code class="descname">git_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#git_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.git_extract" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descclassname">src.system.</code><code class="descname">show_in_editor</code><span class="sig-paren">(</span><em>editor</em>, <em>filePath</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#show_in_editor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.show_in_editor" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descclassname">src.system.</code><code class="descname">svn_extract</code><span class="sig-paren">(</span><em>user</em>, <em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#svn_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.svn_extract" title="Permalink to this definition">¶</a></dt>
+<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="src-template-module"></span><h2>src.template 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><code class="descclassname">src.template.</code><code class="descname">MyTemplate</code><span class="sig-paren">(</span><em>template</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#MyTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.MyTemplate" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">string.Template</span></code></p>
+<dl class="attribute">
+<dt id="src.template.MyTemplate.delimiter">
+<code class="descname">delimiter</code><em class="property"> = '\xc2\xa4'</em><a class="headerlink" href="#src.template.MyTemplate.delimiter" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.template.MyTemplate.pattern">
+<code class="descname">pattern</code><em class="property"> = <_sre.SRE_Pattern object></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">
+<code class="descclassname">src.template.</code><code class="descname">substitute</code><span class="sig-paren">(</span><em>template_file</em>, <em>subst_dic</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#substitute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.substitute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.test_module">
+<span id="src-test-module-module"></span><h2>src.test_module module<a class="headerlink" href="#module-src.test_module" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="src.test_module.Test">
+<em class="property">class </em><code class="descclassname">src.test_module.</code><code class="descname">Test</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>tmp_working_dir</em>, <em>testbase=''</em>, <em>grids=None</em>, <em>sessions=None</em>, <em>launcher=''</em>, <em>show_desktop=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="method">
+<dt id="src.test_module.Test.generate_launching_commands">
+<code class="descname">generate_launching_commands</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_launching_commands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_launching_commands" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.generate_script">
+<code class="descname">generate_script</code><span class="sig-paren">(</span><em>listTest</em>, <em>script_path</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_script" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.get_test_timeout">
+<code class="descname">get_test_timeout</code><span class="sig-paren">(</span><em>test_name</em>, <em>default_value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_test_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_test_timeout" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.get_tmp_dir">
+<code class="descname">get_tmp_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_tmp_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_tmp_dir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase">
+<code class="descname">prepare_testbase</code><span class="sig-paren">(</span><em>test_base_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_dir">
+<code class="descname">prepare_testbase_from_dir</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_dir</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_dir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_git">
+<code class="descname">prepare_testbase_from_git</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_base</em>, <em>testbase_tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_git"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_git" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.prepare_testbase_from_svn">
+<code class="descname">prepare_testbase_from_svn</code><span class="sig-paren">(</span><em>user</em>, <em>testbase_name</em>, <em>testbase_base</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_svn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_svn" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.read_results">
+<code class="descname">read_results</code><span class="sig-paren">(</span><em>listTest</em>, <em>has_timed_out</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.read_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.read_results" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_all_tests">
+<code class="descname">run_all_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_all_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_all_tests" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_grid_tests">
+<code class="descname">run_grid_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_grid_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_grid_tests" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_script">
+<code class="descname">run_script</code><span class="sig-paren">(</span><em>script_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_script" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_session_tests">
+<code class="descname">run_session_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_session_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_session_tests" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_testbase_tests">
+<code class="descname">run_testbase_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_testbase_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_testbase_tests" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.run_tests">
+<code class="descname">run_tests</code><span class="sig-paren">(</span><em>listTest</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_tests" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.search_known_errors">
+<code class="descname">search_known_errors</code><span class="sig-paren">(</span><em>status</em>, <em>test_grid</em>, <em>test_session</em>, <em>test</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.search_known_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.search_known_errors" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.test_module.Test.write_test_margin">
+<code class="descname">write_test_margin</code><span class="sig-paren">(</span><em>tab</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.write_test_margin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.write_test_margin" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.test_module.getTmpDirDEFAULT">
+<code class="descclassname">src.test_module.</code><code class="descname">getTmpDirDEFAULT</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#getTmpDirDEFAULT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.getTmpDirDEFAULT" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.xmlManager">
+<span id="src-xmlmanager-module"></span><h2>src.xmlManager 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><code class="descclassname">src.xmlManager.</code><code class="descname">ReadXmlFile</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Class to manage reading of an xml log file</p>
+<dl class="method">
+<dt id="src.xmlManager.ReadXmlFile.getRootAttrib">
+<code class="descname">getRootAttrib</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.getRootAttrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.getRootAttrib" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descname">get_attrib</code><span class="sig-paren">(</span><em>node_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_attrib" title="Permalink to this definition">¶</a></dt>
+<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">
+<code class="descname">get_node_text</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_node_text" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Get the text of the first node that has name </dt>
+<dd>that corresponds to the parameter node</dd>
+</dl>
+<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>
-</div>
-<div class="section" id="module-src.system">
-<span id="system-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">system</span></code> 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">
-<code class="descclassname">src.system.</code><code class="descname">archive_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>where</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#archive_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.archive_extract" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extracts sources from an archive.</p>
+<dl class="class">
+<dt id="src.xmlManager.XmlLogFile">
+<em class="property">class </em><code class="descclassname">src.xmlManager.</code><code class="descname">XmlLogFile</code><span class="sig-paren">(</span><em>filePath</em>, <em>rootname</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Class to manage writing in salomeTools xml log file</p>
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.add_simple_node">
+<code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.add_simple_node" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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>
-<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">
-<code class="descclassname">src.system.</code><code class="descname">cvs_extract</code><span class="sig-paren">(</span><em>protocol</em>, <em>user</em>, <em>server</em>, <em>base</em>, <em>tag</em>, <em>product</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#cvs_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.cvs_extract" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extracts sources from a cvs repository.</p>
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.append_node_attrib">
+<code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>node_name</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_attrib" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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>
-<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>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.append_node_text">
+<code class="descname">append_node_text</code><span class="sig-paren">(</span><em>node_name</em>, <em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_text" title="Permalink to this definition">¶</a></dt>
+<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>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
-</td>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.xmlManager.XmlLogFile.write_tree">
+<code class="descname">write_tree</code><span class="sig-paren">(</span><em>stylesheet=None</em>, <em>file_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.write_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.write_tree" title="Permalink to this definition">¶</a></dt>
+<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.system.git_extract">
-<code class="descclassname">src.system.</code><code class="descname">git_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#git_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.git_extract" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extracts sources from a git repository.</p>
+<dt id="src.xmlManager.add_simple_node">
+<code class="descclassname">src.xmlManager.</code><code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>root_node</em>, <em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.add_simple_node" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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>
-<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">
-<code class="descclassname">src.system.</code><code class="descname">show_in_editor</code><span class="sig-paren">(</span><em>editor</em>, <em>filePath</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#show_in_editor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.show_in_editor" title="Permalink to this definition">¶</a></dt>
-<dd><p>open filePath using editor.</p>
+<dt id="src.xmlManager.append_node_attrib">
+<code class="descclassname">src.xmlManager.</code><code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>root_node</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.append_node_attrib" title="Permalink to this definition">¶</a></dt>
+<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>filePath</em>) – The editor to use.</li>
-<li><strong>str</strong> – The path to the file to open.</li>
+<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>
</dd></dl>
<dl class="function">
-<dt id="src.system.svn_extract">
-<code class="descclassname">src.system.</code><code class="descname">svn_extract</code><span class="sig-paren">(</span><em>user</em>, <em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#svn_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.svn_extract" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extracts sources from a svn repository.</p>
+<dt id="src.xmlManager.find_node_by_attrib">
+<code class="descclassname">src.xmlManager.</code><code class="descname">find_node_by_attrib</code><span class="sig-paren">(</span><em>xmlroot</em>, <em>name_node</em>, <em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#find_node_by_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.find_node_by_attrib" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Find the nfirst ode from xmlroot that has name name_node and that has in </dt>
+<dd>its attributes {key : value}. Return the node</dd>
+</dl>
<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>
+<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">True if the extraction is successful</p>
+<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">boolean</p>
+<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>
-</div>
-<div class="section" id="module-src.template">
-<span id="template-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">template</span></code> 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><code class="descclassname">src.template.</code><code class="descname">MyTemplate</code><span class="sig-paren">(</span><em>template</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#MyTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.MyTemplate" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">string.Template</span></code></p>
-<dl class="attribute">
-<dt id="src.template.MyTemplate.delimiter">
-<code class="descname">delimiter</code><em class="property"> = '\xc2\xa4'</em><a class="headerlink" href="#src.template.MyTemplate.delimiter" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="src.template.MyTemplate.pattern">
-<code class="descname">pattern</code><em class="property"> = <_sre.SRE_Pattern object at 0x37f8420></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">
-<code class="descclassname">src.template.</code><code class="descname">substitute</code><span class="sig-paren">(</span><em>template_file</em>, <em>subst_dic</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#substitute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.substitute" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt id="src.xmlManager.write_report">
+<code class="descclassname">src.xmlManager.</code><code class="descname">write_report</code><span class="sig-paren">(</span><em>filename</em>, <em>xmlroot</em>, <em>stylesheet</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#write_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.write_report" title="Permalink to this definition">¶</a></dt>
+<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="module-src.test_module">
-<span id="test-module-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">test_module</span></code> Module<a class="headerlink" href="#module-src.test_module" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="module-src">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src" title="Permalink to this headline">¶</a></h2>
+<p>initial imports and utilities methods for salomeTools</p>
<dl class="class">
-<dt id="src.test_module.Test">
-<em class="property">class </em><code class="descclassname">src.test_module.</code><code class="descname">Test</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>tmp_working_dir</em>, <em>testbase=''</em>, <em>grids=None</em>, <em>sessions=None</em>, <em>launcher=''</em>, <em>show_desktop=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path">
+<em class="property">class </em><code class="descclassname">src.</code><code class="descname">Path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
-<dt id="src.test_module.Test.generate_launching_commands">
-<code class="descname">generate_launching_commands</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_launching_commands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_launching_commands" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.base">
+<code class="descname">base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.base" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.generate_script">
-<code class="descname">generate_script</code><span class="sig-paren">(</span><em>listTest</em>, <em>script_path</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_script" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.chmod">
+<code class="descname">chmod</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.chmod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.chmod" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.get_test_timeout">
-<code class="descname">get_test_timeout</code><span class="sig-paren">(</span><em>test_name</em>, <em>default_value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_test_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_test_timeout" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.copy">
+<code class="descname">copy</code><span class="sig-paren">(</span><em>path</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.get_tmp_dir">
-<code class="descname">get_tmp_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_tmp_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_tmp_dir" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.copydir">
+<code class="descname">copydir</code><span class="sig-paren">(</span><em>dst</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copydir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copydir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.prepare_testbase">
-<code class="descname">prepare_testbase</code><span class="sig-paren">(</span><em>test_base_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.copyfile">
+<code class="descname">copyfile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copyfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copyfile" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.prepare_testbase_from_dir">
-<code class="descname">prepare_testbase_from_dir</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_dir</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_dir" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.copylink">
+<code class="descname">copylink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copylink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copylink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.prepare_testbase_from_git">
-<code class="descname">prepare_testbase_from_git</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_base</em>, <em>testbase_tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_git"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_git" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.dir">
+<code class="descname">dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.dir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.prepare_testbase_from_svn">
-<code class="descname">prepare_testbase_from_svn</code><span class="sig-paren">(</span><em>user</em>, <em>testbase_name</em>, <em>testbase_base</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_svn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_svn" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.exists">
+<code class="descname">exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.exists" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.read_results">
-<code class="descname">read_results</code><span class="sig-paren">(</span><em>listTest</em>, <em>has_timed_out</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.read_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.read_results" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.isdir">
+<code class="descname">isdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.isdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_all_tests">
-<code class="descname">run_all_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_all_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_all_tests" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.isfile">
+<code class="descname">isfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.isfile" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_grid_tests">
-<code class="descname">run_grid_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_grid_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_grid_tests" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.islink">
+<code class="descname">islink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.islink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.islink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_script">
-<code class="descname">run_script</code><span class="sig-paren">(</span><em>script_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_script" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.list">
+<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.list" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_session_tests">
-<code class="descname">run_session_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_session_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_session_tests" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.make">
+<code class="descname">make</code><span class="sig-paren">(</span><em>mode=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.make" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_testbase_tests">
-<code class="descname">run_testbase_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_testbase_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_testbase_tests" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.readlink">
+<code class="descname">readlink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.readlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.readlink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.run_tests">
-<code class="descname">run_tests</code><span class="sig-paren">(</span><em>listTest</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_tests" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.rm">
+<code class="descname">rm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.rm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.rm" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.search_known_errors">
-<code class="descname">search_known_errors</code><span class="sig-paren">(</span><em>status</em>, <em>test_grid</em>, <em>test_session</em>, <em>test</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.search_known_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.search_known_errors" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.smartcopy">
+<code class="descname">smartcopy</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.smartcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.smartcopy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.test_module.Test.write_test_margin">
-<code class="descname">write_test_margin</code><span class="sig-paren">(</span><em>tab</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.write_test_margin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.write_test_margin" title="Permalink to this definition">¶</a></dt>
+<dt id="src.Path.symlink">
+<code class="descname">symlink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.symlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.symlink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
+<dl class="exception">
+<dt id="src.SatException">
+<em class="property">exception </em><code class="descclassname">src.</code><code class="descname">SatException</code><a class="reference internal" href="../../_modules/src.html#SatException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.SatException" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">exceptions.Exception</span></code></p>
+<p>rename Exception Class</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.activate_mesa_property">
+<code class="descclassname">src.</code><code class="descname">activate_mesa_property</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#activate_mesa_property"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.activate_mesa_property" title="Permalink to this definition">¶</a></dt>
+<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.test_module.getTmpDirDEFAULT">
-<code class="descclassname">src.test_module.</code><code class="descname">getTmpDirDEFAULT</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#getTmpDirDEFAULT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.getTmpDirDEFAULT" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</div>
-<div class="section" id="module-src.xmlManager">
-<span id="xmlmanager-module"></span><h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlManager</span></code> 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><code class="descclassname">src.xmlManager.</code><code class="descname">ReadXmlFile</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Class to manage reading of an xml log file</p>
-<dl class="method">
-<dt id="src.xmlManager.ReadXmlFile.getRootAttrib">
-<code class="descname">getRootAttrib</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.getRootAttrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.getRootAttrib" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the attibutes of the self.xmlroot</p>
+<dt id="src.check_config_has_application">
+<code class="descclassname">src.</code><code class="descname">check_config_has_application</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#check_config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.check_config_has_application" title="Permalink to this definition">¶</a></dt>
+<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">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 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="method">
-<dt id="src.xmlManager.ReadXmlFile.get_attrib">
-<code class="descname">get_attrib</code><span class="sig-paren">(</span><em>node_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_attrib" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the attibutes of the node node_name in self.xmlroot</p>
+<dl class="function">
+<dt id="src.check_config_has_profile">
+<code class="descclassname">src.</code><code class="descname">check_config_has_profile</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#check_config_has_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.check_config_has_profile" title="Permalink to this definition">¶</a></dt>
+<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>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 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="method">
-<dt id="src.xmlManager.ReadXmlFile.get_node_text">
-<code class="descname">get_node_text</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_node_text" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Get the text of the first node that has name </dt>
-<dd>that corresponds to the parameter node</dd>
-</dl>
+<dl class="function">
+<dt id="src.config_has_application">
+<code class="descclassname">src.</code><code class="descname">config_has_application</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.config_has_application" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.deepcopy_list">
+<code class="descclassname">src.</code><code class="descname">deepcopy_list</code><span class="sig-paren">(</span><em>input_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#deepcopy_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.deepcopy_list" title="Permalink to this definition">¶</a></dt>
+<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>str</strong> (<em>node</em>) – the name of the node from which get the text</td>
+<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 text of the first node that has name
-that corresponds to the parameter node</td>
+<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">str</td>
+<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.ensure_path_exists">
+<code class="descclassname">src.</code><code class="descname">ensure_path_exists</code><span class="sig-paren">(</span><em>p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#ensure_path_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ensure_path_exists" title="Permalink to this definition">¶</a></dt>
+<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="class">
-<dt id="src.xmlManager.XmlLogFile">
-<em class="property">class </em><code class="descclassname">src.xmlManager.</code><code class="descname">XmlLogFile</code><span class="sig-paren">(</span><em>filePath</em>, <em>rootname</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Class to manage writing in salomeTools xml log file</p>
-<dl class="method">
-<dt id="src.xmlManager.XmlLogFile.add_simple_node">
-<code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.add_simple_node" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a node with some attibutes and text to the root node.</p>
+<dl class="function">
+<dt id="src.find_file_in_lpath">
+<code class="descclassname">src.</code><code class="descname">find_file_in_lpath</code><span class="sig-paren">(</span><em>file_name</em>, <em>lpath</em>, <em>additional_dir=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#find_file_in_lpath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.find_file_in_lpath" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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="method">
-<dt id="src.xmlManager.XmlLogFile.append_node_attrib">
-<code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>node_name</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_attrib" title="Permalink to this definition">¶</a></dt>
-<dd><p>Append a new attributes to the node that has node_name as name</p>
+<dl class="function">
+<dt id="src.get_base_path">
+<code class="descclassname">src.</code><code class="descname">get_base_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_base_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_base_path" title="Permalink to this definition">¶</a></dt>
+<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"><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 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="method">
-<dt id="src.xmlManager.XmlLogFile.append_node_text">
-<code class="descname">append_node_text</code><span class="sig-paren">(</span><em>node_name</em>, <em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_text" title="Permalink to this definition">¶</a></dt>
-<dd><p>Append a new text to the node that has node_name as name</p>
+<dl class="function">
+<dt id="src.get_cfg_param">
+<code class="descclassname">src.</code><code class="descname">get_cfg_param</code><span class="sig-paren">(</span><em>config</em>, <em>param_name</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_cfg_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_cfg_param" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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="method">
-<dt id="src.xmlManager.XmlLogFile.write_tree">
-<code class="descname">write_tree</code><span class="sig-paren">(</span><em>stylesheet=None</em>, <em>file_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.write_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.write_tree" title="Permalink to this definition">¶</a></dt>
-<dd><p>Write the xml tree in the log file path. Add the stylesheet if asked.</p>
+<dl class="function">
+<dt id="src.get_launcher_name">
+<code class="descclassname">src.</code><code class="descname">get_launcher_name</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_launcher_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_launcher_name" title="Permalink to this definition">¶</a></dt>
+<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>str</strong> (<em>stylesheet</em>) – The stylesheet to apply to the xml file</td>
+<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>
-</dd></dl>
-
<dl class="function">
-<dt id="src.xmlManager.add_simple_node">
-<code class="descclassname">src.xmlManager.</code><code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>root_node</em>, <em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.add_simple_node" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a node with some attibutes and text to the root node.</p>
+<dt id="src.get_log_path">
+<code class="descclassname">src.</code><code class="descname">get_log_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_log_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_log_path" title="Permalink to this definition">¶</a></dt>
+<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"><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 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.xmlManager.append_node_attrib">
-<code class="descclassname">src.xmlManager.</code><code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>root_node</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.append_node_attrib" title="Permalink to this definition">¶</a></dt>
-<dd><p>Append a new attributes to the node that has node_name as name</p>
+<dt id="src.get_property_in_product_cfg">
+<code class="descclassname">src.</code><code class="descname">get_property_in_product_cfg</code><span class="sig-paren">(</span><em>product_cfg</em>, <em>pprty</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_property_in_product_cfg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_property_in_product_cfg" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.get_salome_version">
+<code class="descclassname">src.</code><code class="descname">get_salome_version</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_salome_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_salome_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.get_tmp_filename">
+<code class="descclassname">src.</code><code class="descname">get_tmp_filename</code><span class="sig-paren">(</span><em>cfg</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_tmp_filename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_tmp_filename" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.handleRemoveReadonly">
+<code class="descclassname">src.</code><code class="descname">handleRemoveReadonly</code><span class="sig-paren">(</span><em>func</em>, <em>path</em>, <em>exc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#handleRemoveReadonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.handleRemoveReadonly" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.merge_dicts">
+<code class="descclassname">src.</code><code class="descname">merge_dicts</code><span class="sig-paren">(</span><em>*dict_args</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#merge_dicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.merge_dicts" title="Permalink to this definition">¶</a></dt>
+<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.only_numbers">
+<code class="descclassname">src.</code><code class="descname">only_numbers</code><span class="sig-paren">(</span><em>str_num</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#only_numbers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.only_numbers" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.parse_date">
+<code class="descclassname">src.</code><code class="descname">parse_date</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#parse_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.parse_date" title="Permalink to this definition">¶</a></dt>
+<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"><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 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.xmlManager.find_node_by_attrib">
-<code class="descclassname">src.xmlManager.</code><code class="descname">find_node_by_attrib</code><span class="sig-paren">(</span><em>xmlroot</em>, <em>name_node</em>, <em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#find_node_by_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.find_node_by_attrib" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Find the nfirst ode from xmlroot that has name name_node and that has in </dt>
-<dd>its attributes {key : value}. Return the node</dd>
-</dl>
+<dt id="src.print_info">
+<code class="descclassname">src.</code><code class="descname">print_info</code><span class="sig-paren">(</span><em>logger</em>, <em>info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.print_info" title="Permalink to this definition">¶</a></dt>
+<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 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>
+<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>
-<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">
-<code class="descclassname">src.xmlManager.</code><code class="descname">write_report</code><span class="sig-paren">(</span><em>filename</em>, <em>xmlroot</em>, <em>stylesheet</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#write_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.write_report" title="Permalink to this definition">¶</a></dt>
-<dd><p>Writes a report file from a XML tree.</p>
+<dt id="src.read_config_from_a_file">
+<code class="descclassname">src.</code><code class="descname">read_config_from_a_file</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#read_config_from_a_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.read_config_from_a_file" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.remove_item_from_list">
+<code class="descclassname">src.</code><code class="descname">remove_item_from_list</code><span class="sig-paren">(</span><em>input_list</em>, <em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#remove_item_from_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.remove_item_from_list" title="Permalink to this definition">¶</a></dt>
+<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"><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 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>
-</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"><code class="docutils literal notranslate"><span class="pre">colorama</span></code> Package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi"><code class="docutils literal notranslate"><span class="pre">ansi</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32"><code class="docutils literal notranslate"><span class="pre">ansitowin32</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise"><code class="docutils literal notranslate"><span class="pre">initialise</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32"><code class="docutils literal notranslate"><span class="pre">win32</span></code> Module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm"><code class="docutils literal notranslate"><span class="pre">winterm</span></code> Module</a></li>
-</ul>
-</li>
-</ul>
-</div>
+<dl class="function">
+<dt id="src.replace_in_file">
+<code class="descclassname">src.</code><code class="descname">replace_in_file</code><span class="sig-paren">(</span><em>filein</em>, <em>strin</em>, <em>strout</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#replace_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.replace_in_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replace <strin> by <strout> in file <filein></p>
+</dd></dl>
+
</div>
</div>
</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"><code class="docutils literal notranslate"><span class="pre">src</span></code> Package</a></li>
-<li><a class="reference internal" href="#module-src.ElementTree"><code class="docutils literal notranslate"><span class="pre">ElementTree</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.architecture"><code class="docutils literal notranslate"><span class="pre">architecture</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.compilation"><code class="docutils literal notranslate"><span class="pre">compilation</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.debug"><code class="docutils literal notranslate"><span class="pre">debug</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.environment"><code class="docutils literal notranslate"><span class="pre">environment</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.fileEnviron"><code class="docutils literal notranslate"><span class="pre">fileEnviron</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.fork"><code class="docutils literal notranslate"><span class="pre">fork</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.logger"><code class="docutils literal notranslate"><span class="pre">logger</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.options"><code class="docutils literal notranslate"><span class="pre">options</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.printcolors"><code class="docutils literal notranslate"><span class="pre">printcolors</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.product"><code class="docutils literal notranslate"><span class="pre">product</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.pyconf"><code class="docutils literal notranslate"><span class="pre">pyconf</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.system"><code class="docutils literal notranslate"><span class="pre">system</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.template"><code class="docutils literal notranslate"><span class="pre">template</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.test_module"><code class="docutils literal notranslate"><span class="pre">test_module</span></code> Module</a></li>
-<li><a class="reference internal" href="#module-src.xmlManager"><code class="docutils literal notranslate"><span class="pre">xmlManager</span></code> Module</a></li>
+<li><a class="reference internal" href="#">src package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-src.ElementTree">src.ElementTree module</a></li>
+<li><a class="reference internal" href="#module-src.architecture">src.architecture module</a></li>
+<li><a class="reference internal" href="#module-src.compilation">src.compilation module</a></li>
+<li><a class="reference internal" href="#module-src.debug">src.debug module</a></li>
+<li><a class="reference internal" href="#module-src.environment">src.environment module</a></li>
+<li><a class="reference internal" href="#module-src.fileEnviron">src.fileEnviron module</a></li>
+<li><a class="reference internal" href="#module-src.fork">src.fork module</a></li>
+<li><a class="reference internal" href="#module-src.logger">src.logger module</a></li>
+<li><a class="reference internal" href="#module-src.options">src.options module</a></li>
+<li><a class="reference internal" href="#module-src.printcolors">src.printcolors module</a></li>
+<li><a class="reference internal" href="#module-src.product">src.product module</a></li>
+<li><a class="reference internal" href="#module-src.pyconf">src.pyconf module</a></li>
+<li><a class="reference internal" href="#module-src.system">src.system module</a></li>
+<li><a class="reference internal" href="#module-src.template">src.template module</a></li>
+<li><a class="reference internal" href="#module-src.test_module">src.test_module module</a></li>
+<li><a class="reference internal" href="#module-src.xmlManager">src.xmlManager module</a></li>
+<li><a class="reference internal" href="#module-src">Module contents</a></li>
</ul>
</li>
</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>
+ <li>Next: <a href="src.colorama.html" title="next chapter">src.colorama package</a></li>
</ul></li>
</ul></li>
</ul>
--- /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="X-UA-Compatible" content="IE=Edge" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>Command doc — 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" />
+ <script type="text/javascript" src="../_static/documentation_options.js"></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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Command config" href="config.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-doc">
+<h1>Command doc<a class="headerlink" href="#command-doc" 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>doc</strong> command displays sat documentation.</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 sat documentation:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">html</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Show (in evince, for example) the (same) sat documentation in format pdf:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">pdf</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Edit and modify in your preference user editor the sources files (rst) of sat documentation:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">edit</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">get information how to compile locally sat documentation (from the sources files):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="nb">compile</span>
+</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>
+<ul class="simple">
+<li><strong>USER</strong><ul>
+<li><strong>browser</strong> : The browser used to show the html files (<em>firefox</em> for example).</li>
+<li><strong>pdf_viewer</strong> : The viewer used to show the pdf files (<em>evince</em> for example).</li>
+<li><strong>editor</strong> : The editor used to edit ascii text files (<em>pluma or gedit</em> for example).</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <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 doc</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="config.html" title="next chapter">Command config</a></li>
+ </ul></li>
+</ul>
+</div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/commands/doc.rst.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <div class="searchformwrapper">
+ <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>
+ </div>
+</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.7.3</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+
+ |
+ <a href="../_sources/commands/doc.rst.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.__init__.activate_mesa_property">activate_mesa_property() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.activate_mesa_property">activate_mesa_property() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">add() (src.fileEnviron.LauncherFileEnviron method)</a>
</li>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.back">back() (src.colorama.winterm.WinTerm method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.base">base() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.base">base() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">BashFileEnviron (class in src.fileEnviron)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.product.check_config_exists">check_config_exists() (in module src.product)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.check_config_has_application">check_config_has_application() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.check_config_has_application">check_config_has_application() (in module src)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.check_config_has_profile">check_config_has_profile() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.check_config_has_profile">check_config_has_profile() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.check_installation">check_installation() (in module src.product)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.check_source">check_source() (in module src.product)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.chmod">chmod() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.chmod">chmod() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.printcolors.cleancolor">cleancolor() (in module src.printcolors)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.Config.Namespace">Config.Namespace (class in src.pyconf)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.config_has_application">config_has_application() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.config_has_application">config_has_application() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigError">ConfigError</a>
</li>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_osc">convert_osc() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copy">copy() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.copy">copy() (src.Path method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copydir">copydir() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.copydir">copydir() (src.Path method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copyfile">copyfile() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.copyfile">copyfile() (src.Path method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copylink">copylink() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.copylink">copylink() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.cursor_adjust">cursor_adjust() (src.colorama.winterm.WinTerm method)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.logger.date_to_datetime">date_to_datetime() (in module src.logger)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.deepcopy_list">deepcopy_list() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.options.Options.debug_write">debug_write() (src.options.Options method)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.deepcopy_list">deepcopy_list() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.deepCopyMapping">deepCopyMapping() (in module src.pyconf)</a>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.deinit">deinit() (in module src.colorama.initialise)</a>
</li>
<li><a href="commands/apidoc/src.html#src.template.MyTemplate.delimiter">delimiter (src.template.MyTemplate attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.DIM">DIM (src.colorama.ansi.AnsiStyle attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.dir">dir() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.DIM">DIM (src.colorama.ansi.AnsiStyle attribute)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.Path.dir">dir() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.compilation.Builder.do_batch_script_build">do_batch_script_build() (src.compilation.Builder method)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.logger.Logger.end_write">end_write() (src.logger.Logger method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.ensure_path_exists">ensure_path_exists() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.ensure_path_exists">ensure_path_exists() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.environment.Environ">Environ (class in src.environment)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.Expression.evaluate">(src.pyconf.Expression method)</a>
</li>
</ul></li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.exists">exists() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.exists">exists() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.Expression">Expression (class in src.pyconf)</a>
</li>
<li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron">FileEnviron (class in src.fileEnviron)</a>
</li>
<li><a href="commands/apidoc/src.html#src.environment.FileEnvWriter">FileEnvWriter (class in src.environment)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.options.Options.filterLevel">filterLevel() (src.options.Options method)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.options.Options.filterList2">filterList2() (src.options.Options method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.find">find() (src.ElementTree.ElementTree method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.find_file_in_lpath">find_file_in_lpath() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.find_file_in_lpath">find_file_in_lpath() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.xmlManager.find_node_by_attrib">find_node_by_attrib() (in module src.xmlManager)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findtext">findtext() (src.ElementTree.ElementTree method)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.finish">finish() (src.environment.SalomeEnviron method)</a>
<ul>
<li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.finish">(src.fileEnviron.LauncherFileEnviron method)</a>
</li>
</ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.logger.Logger.flush">flush() (src.logger.Logger method)</a>
<ul>
</li>
<li><a href="commands/apidoc/src.html#src.product.get_base_install_dir">get_base_install_dir() (in module src.product)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_base_path">get_base_path() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_base_path">get_base_path() (in module src)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_cfg_param">get_cfg_param() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_cfg_param">get_cfg_param() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.architecture.get_distrib_version">get_distrib_version() (in module src.architecture)</a>
</li>
<li><a href="commands/apidoc/src.html#src.architecture.get_distribution">get_distribution() (in module src.architecture)</a>
</li>
<li><a href="commands/apidoc/src.html#src.fileEnviron.get_file_environ">get_file_environ() (in module src.fileEnviron)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.options.Options.get_help">get_help() (src.options.Options method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.get_install_dir">get_install_dir() (in module src.product)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_launcher_name">get_launcher_name() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_launcher_name">get_launcher_name() (in module src)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_log_path">get_log_path() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_log_path">get_log_path() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get_names">get_names() (src.environment.SalomeEnviron method)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.product.get_products_infos">get_products_infos() (in module src.product)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_property_in_product_cfg">get_property_in_product_cfg() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_property_in_product_cfg">get_property_in_product_cfg() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.architecture.get_python_version">get_python_version() (in module src.architecture)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_salome_version">get_salome_version() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_salome_version">get_salome_version() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.test_module.Test.get_test_timeout">get_test_timeout() (src.test_module.Test method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.test_module.Test.get_tmp_dir">get_tmp_dir() (src.test_module.Test method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.get_tmp_filename">get_tmp_filename() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.get_tmp_filename">get_tmp_filename() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.architecture.get_user">get_user() (in module src.architecture)</a>
</li>
</li>
</ul></li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getChar">getChar() (src.pyconf.ConfigReader method)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.options.Options.getDetailOption">getDetailOption() (src.options.Options method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getiterator">getiterator() (src.ElementTree.ElementTree method)</a>
</li>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.handleMismatch">handleMismatch() (src.pyconf.ConfigMerger method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.handleRemoveReadonly">handleRemoveReadonly() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.handleRemoveReadonly">handleRemoveReadonly() (in module src)</a>
</li>
</ul></td>
</tr></table>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.debug.indent">indent() (in module src.debug)</a>
+
+ <ul>
+ <li><a href="commands/apidoc/src.html#src.options.Options.indent">(src.options.Options method)</a>
</li>
+ </ul></li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.init">init() (in module src.colorama.initialise)</a>
</li>
<li><a href="commands/apidoc/src.html#src.compilation.Builder.install">install() (src.compilation.Builder method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.architecture.is_windows">is_windows() (in module src.architecture)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.isdir">isdir() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.isdir">isdir() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.ElementTree.iselement">iselement() (in module src.ElementTree)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.isfile">isfile() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.isfile">isfile() (src.Path method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.islink">islink() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.islink">islink() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.isWord">isWord() (in module src.pyconf)</a>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX">(src.colorama.ansi.AnsiFore attribute)</a>
</li>
</ul></li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.list">list() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.list">list() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.logger.list_log_file">list_log_file() (in module src.logger)</a>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.MAGENTA">(src.colorama.winterm.WinColor attribute)</a>
</li>
</ul></li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.make">make() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.compilation.Builder.make">make() (src.compilation.Builder method)</a>
<ul>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.make">(src.compilation.Builder method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.make">(src.Path method)</a>
</li>
</ul></li>
<li><a href="commands/apidoc/src.html#src.pyconf.makePath">makePath() (in module src.pyconf)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.merge">merge() (src.pyconf.ConfigMerger method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.merge_dicts">merge_dicts() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.merge_dicts">merge_dicts() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeMapping">mergeMapping() (src.pyconf.ConfigMerger method)</a>
</li>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.__init__.only_numbers">only_numbers() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.only_numbers">only_numbers() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.options.Options">Options (class in src.options)</a>
</li>
</ul></li>
<li><a href="commands/apidoc/src.html#src.options.Options.parse_args">parse_args() (src.options.Options method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.parse_date">parse_date() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.parse_date">parse_date() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseFactor">parseFactor() (src.pyconf.ConfigReader method)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseValue">parseValue() (src.pyconf.ConfigReader method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path">Path (class in src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.Path">Path (class in src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.template.MyTemplate.pattern">pattern (src.template.MyTemplate attribute)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.options.Options.print_help">print_help() (src.options.Options method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.print_info">print_info() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.print_info">print_info() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.printcolors.print_value">print_value() (in module src.printcolors)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.product_is_native">product_is_native() (in module src.product)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.product_is_salome">product_is_salome() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_sample">product_is_sample() (in module src.product)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.product_is_smesh_plugin">product_is_smesh_plugin() (in module src.product)</a>
</li>
<li><a href="commands/apidoc/src.html#src.product.product_is_vcs">product_is_vcs() (in module src.product)</a>
+</li>
+ <li><a href="commands/apidoc/src.html#src.product.product_is_verbose">product_is_verbose() (in module src.product)</a>
</li>
<li><a href="commands/apidoc/src.html#src.debug.push_debug">push_debug() (in module src.debug)</a>
</li>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.read">read() (src.pyconf.ConfigInputStream method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.read_config_from_a_file">read_config_from_a_file() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.read_config_from_a_file">read_config_from_a_file() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.test_module.Test.read_results">read_results() (src.test_module.Test method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.readline">readline() (src.pyconf.ConfigInputStream method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.readlink">readlink() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.readlink">readlink() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile">ReadXmlFile (class in src.xmlManager)</a>
</li>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reinit">reinit() (in module src.colorama.initialise)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.remove_item_from_list">remove_item_from_list() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.remove_item_from_list">remove_item_from_list() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.html#src.pyconf.Config.removeNamespace">removeNamespace() (src.pyconf.Config method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.replace_in_file">replace_in_file() (in module src.__init__)</a>
+ <li><a href="commands/apidoc/src.html#src.replace_in_file">replace_in_file() (in module src)</a>
</li>
<li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RESET">RESET (src.colorama.ansi.AnsiBack attribute)</a>
</ul></li>
<li><a href="commands/apidoc/src.html#src.pyconf.Reference.resolve">resolve() (src.pyconf.Reference method)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.rm">rm() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.rm">rm() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.test_module.Test.run_all_tests">run_all_tests() (src.test_module.Test method)</a>
</li>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron">SalomeEnviron (class in src.environment)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.SatException">SatException</a>
+ <li><a href="commands/apidoc/src.html#src.SatException">SatException</a>
</li>
<li><a href="commands/apidoc/src.html#src.debug.saveConfigDbg">saveConfigDbg() (in module src.debug)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.fork.show_progress">show_progress() (in module src.fork)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.smartcopy">smartcopy() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.smartcopy">smartcopy() (src.Path method)</a>
</li>
<li><a href="commands/apidoc/src.html#src.fileEnviron.special_path_separator">special_path_separator() (in module src.fileEnviron)</a>
</li>
- <li><a href="commands/apidoc/src.html#module-src.__init__">src.__init__ (module)</a>
+ <li><a href="commands/apidoc/src.html#module-src">src (module)</a>
</li>
<li><a href="commands/apidoc/src.html#module-src.architecture">src.architecture (module)</a>
</li>
</li>
<li><a href="commands/apidoc/src.html#src.system.svn_extract">svn_extract() (in module src.system)</a>
</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.symlink">symlink() (src.__init__.Path method)</a>
+ <li><a href="commands/apidoc/src.html#src.Path.symlink">symlink() (src.Path method)</a>
</li>
</ul></td>
</tr></table>
<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/doc.html">doc</a></li>
<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>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
- <code class="xref">src</code></td><td>
- <em></em></td></tr>
- <tr class="cg-1">
- <td></td>
- <td>   
- <a href="commands/apidoc/src.html#module-src.__init__"><code class="xref">src.__init__</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src"><code class="xref">src</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="prev" title="colorama Package" href="../commands/apidoc/src.colorama.html" />
+ <link rel="prev" title="src.colorama package" href="../commands/apidoc/src.colorama.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<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>
+ <li>Previous: <a href="../commands/apidoc/src.colorama.html" title="previous chapter">src.colorama package</a></li>
</ul></li>
</ul>
</div>
-Search.setIndex({docnames:["commands/apidoc/modules","commands/apidoc/src","commands/apidoc/src.colorama","commands/application","commands/clean","commands/compile","commands/config","commands/environ","commands/generate","commands/launcher","commands/log","commands/package","commands/prepare","configuration","index","installation_of_sat","release_notes/release_notes_5.0.0","usage_of_sat","write_command"],envversion:52,filenames:["commands/apidoc/modules.rst","commands/apidoc/src.rst","commands/apidoc/src.colorama.rst","commands/application.rst","commands/clean.rst","commands/compile.rst","commands/config.rst","commands/environ.rst","commands/generate.rst","commands/launcher.rst","commands/log.rst","commands/package.rst","commands/prepare.rst","configuration.rst","index.rst","installation_of_sat.rst","release_notes/release_notes_5.0.0.rst","usage_of_sat.rst","write_command.rst"],objects:{"src.ElementTree":{Comment:[1,1,1,""],Element:[1,1,1,""],ElementTree:[1,2,1,""],PI:[1,1,1,""],ProcessingInstruction:[1,1,1,""],QName:[1,2,1,""],SubElement:[1,1,1,""],TreeBuilder:[1,2,1,""],XML:[1,1,1,""],XMLTreeBuilder:[1,2,1,""],dump:[1,1,1,""],fromstring:[1,1,1,""],iselement:[1,1,1,""],iterparse:[1,2,1,""],parse:[1,1,1,""],tostring:[1,1,1,""]},"src.ElementTree.ElementTree":{find:[1,3,1,""],findall:[1,3,1,""],findtext:[1,3,1,""],getiterator:[1,3,1,""],getroot:[1,3,1,""],parse:[1,3,1,""],write:[1,3,1,""]},"src.ElementTree.TreeBuilder":{close:[1,3,1,""],data:[1,3,1,""],end:[1,3,1,""],start:[1,3,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[1,3,1,""],doctype:[1,3,1,""],feed:[1,3,1,""]},"src.ElementTree.iterparse":{next:[1,3,1,""]},"src.__init__":{Path:[1,2,1,""],SatException:[1,4,1,""],activate_mesa_property:[1,1,1,""],check_config_has_application:[1,1,1,""],check_config_has_profile:[1,1,1,""],config_has_application:[1,1,1,""],deepcopy_list:[1,1,1,""],ensure_path_exists:[1,1,1,""],find_file_in_lpath:[1,1,1,""],get_base_path:[1,1,1,""],get_cfg_param:[1,1,1,""],get_launcher_name:[1,1,1,""],get_log_path:[1,1,1,""],get_property_in_product_cfg:[1,1,1,""],get_salome_version:[1,1,1,""],get_tmp_filename:[1,1,1,""],handleRemoveReadonly:[1,1,1,""],merge_dicts:[1,1,1,""],only_numbers:[1,1,1,""],parse_date:[1,1,1,""],print_info:[1,1,1,""],read_config_from_a_file:[1,1,1,""],remove_item_from_list:[1,1,1,""],replace_in_file:[1,1,1,""]},"src.__init__.Path":{base:[1,3,1,""],chmod:[1,3,1,""],copy:[1,3,1,""],copydir:[1,3,1,""],copyfile:[1,3,1,""],copylink:[1,3,1,""],dir:[1,3,1,""],exists:[1,3,1,""],isdir:[1,3,1,""],isfile:[1,3,1,""],islink:[1,3,1,""],list:[1,3,1,""],make:[1,3,1,""],readlink:[1,3,1,""],rm:[1,3,1,""],smartcopy:[1,3,1,""],symlink:[1,3,1,""]},"src.architecture":{get_distrib_version:[1,1,1,""],get_distribution:[1,1,1,""],get_nb_proc:[1,1,1,""],get_python_version:[1,1,1,""],get_user:[1,1,1,""],is_windows:[1,1,1,""]},"src.colorama":{ansi:[2,0,0,"-"],ansitowin32:[2,0,0,"-"],initialise:[2,0,0,"-"],win32:[2,0,0,"-"],winterm:[2,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[2,2,1,""],AnsiCodes:[2,2,1,""],AnsiCursor:[2,2,1,""],AnsiFore:[2,2,1,""],AnsiStyle:[2,2,1,""],clear_line:[2,1,1,""],clear_screen:[2,1,1,""],code_to_chars:[2,1,1,""],set_title:[2,1,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[2,3,1,""],DOWN:[2,3,1,""],FORWARD:[2,3,1,""],POS:[2,3,1,""],UP:[2,3,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[2,5,1,""],DIM:[2,5,1,""],NORMAL:[2,5,1,""],RESET_ALL:[2,5,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[2,2,1,""],StreamWrapper:[2,2,1,""],is_a_tty:[2,1,1,""],is_stream_closed:[2,1,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[2,5,1,""],ANSI_OSC_RE:[2,5,1,""],call_win32:[2,3,1,""],convert_ansi:[2,3,1,""],convert_osc:[2,3,1,""],extract_params:[2,3,1,""],get_win32_calls:[2,3,1,""],reset_all:[2,3,1,""],should_wrap:[2,3,1,""],write:[2,3,1,""],write_and_convert:[2,3,1,""],write_plain_text:[2,3,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[2,3,1,""]},"src.colorama.initialise":{colorama_text:[2,1,1,""],deinit:[2,1,1,""],init:[2,1,1,""],reinit:[2,1,1,""],reset_all:[2,1,1,""],wrap_stream:[2,1,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[2,1,1,""],winapi_test:[2,1,1,""]},"src.colorama.winterm":{WinColor:[2,2,1,""],WinStyle:[2,2,1,""],WinTerm:[2,2,1,""]},"src.colorama.winterm.WinColor":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],GREY:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[2,5,1,""],BRIGHT_BACKGROUND:[2,5,1,""],NORMAL:[2,5,1,""]},"src.colorama.winterm.WinTerm":{back:[2,3,1,""],cursor_adjust:[2,3,1,""],erase_line:[2,3,1,""],erase_screen:[2,3,1,""],fore:[2,3,1,""],get_attrs:[2,3,1,""],get_position:[2,3,1,""],reset_all:[2,3,1,""],set_attrs:[2,3,1,""],set_console:[2,3,1,""],set_cursor_position:[2,3,1,""],set_title:[2,3,1,""],style:[2,3,1,""]},"src.compilation":{Builder:[1,2,1,""]},"src.compilation.Builder":{build_configure:[1,3,1,""],check:[1,3,1,""],cmake:[1,3,1,""],complete_environment:[1,3,1,""],configure:[1,3,1,""],do_batch_script_build:[1,3,1,""],do_default_build:[1,3,1,""],do_python_script_build:[1,3,1,""],do_script_build:[1,3,1,""],hack_libtool:[1,3,1,""],install:[1,3,1,""],log:[1,3,1,""],log_command:[1,3,1,""],make:[1,3,1,""],prepare:[1,3,1,""],put_txt_log_in_appli_log_dir:[1,3,1,""],wmake:[1,3,1,""]},"src.debug":{InStream:[1,2,1,""],OutStream:[1,2,1,""],getLocalEnv:[1,1,1,""],getStrConfigDbg:[1,1,1,""],getStrConfigStd:[1,1,1,""],indent:[1,1,1,""],pop_debug:[1,1,1,""],push_debug:[1,1,1,""],saveConfigDbg:[1,1,1,""],saveConfigStd:[1,1,1,""],tofix:[1,1,1,""],write:[1,1,1,""]},"src.debug.OutStream":{close:[1,3,1,""]},"src.environment":{Environ:[1,2,1,""],FileEnvWriter:[1,2,1,""],SalomeEnviron:[1,2,1,""],Shell:[1,2,1,""],load_environment:[1,1,1,""]},"src.environment.Environ":{append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[1,3,1,""],write_env_file:[1,3,1,""]},"src.environment.SalomeEnviron":{add_comment:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],dump:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],get_names:[1,3,1,""],is_defined:[1,3,1,""],load_cfg_environment:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],run_simple_env_script:[1,3,1,""],set:[1,3,1,""],set_a_product:[1,3,1,""],set_application_env:[1,3,1,""],set_cpp_env:[1,3,1,""],set_full_environ:[1,3,1,""],set_products:[1,3,1,""],set_python_libdirs:[1,3,1,""],set_salome_generic_product_env:[1,3,1,""],set_salome_minimal_product_env:[1,3,1,""]},"src.fileEnviron":{BashFileEnviron:[1,2,1,""],BatFileEnviron:[1,2,1,""],ContextFileEnviron:[1,2,1,""],FileEnviron:[1,2,1,""],LauncherFileEnviron:[1,2,1,""],ScreenEnviron:[1,2,1,""],get_file_environ:[1,1,1,""],special_path_separator:[1,1,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[1,3,1,""],finish:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[1,3,1,""],add_warning:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[1,3,1,""],add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],change_to_launcher:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],set:[1,3,1,""],write:[1,3,1,""]},"src.fork":{batch:[1,1,1,""],batch_salome:[1,1,1,""],launch_command:[1,1,1,""],show_progress:[1,1,1,""],write_back:[1,1,1,""]},"src.logger":{Logger:[1,2,1,""],date_to_datetime:[1,1,1,""],list_log_file:[1,1,1,""],show_command_log:[1,1,1,""],timedelta_total_seconds:[1,1,1,""],update_hat_xml:[1,1,1,""]},"src.logger.Logger":{add_link:[1,3,1,""],end_write:[1,3,1,""],error:[1,3,1,""],flush:[1,3,1,""],put_initial_xml_fields:[1,3,1,""],write:[1,3,1,""]},"src.options":{OptResult:[1,2,1,""],Options:[1,2,1,""]},"src.options.Options":{add_option:[1,3,1,""],parse_args:[1,3,1,""],print_help:[1,3,1,""]},"src.printcolors":{cleancolor:[1,1,1,""],print_color_map:[1,1,1,""],print_color_range:[1,1,1,""],print_value:[1,1,1,""],printc:[1,1,1,""],printcError:[1,1,1,""],printcHeader:[1,1,1,""],printcHighlight:[1,1,1,""],printcInfo:[1,1,1,""],printcLabel:[1,1,1,""],printcSuccess:[1,1,1,""],printcWarning:[1,1,1,""]},"src.product":{check_config_exists:[1,1,1,""],check_installation:[1,1,1,""],check_source:[1,1,1,""],get_base_install_dir:[1,1,1,""],get_install_dir:[1,1,1,""],get_product_components:[1,1,1,""],get_product_config:[1,1,1,""],get_product_dependencies:[1,1,1,""],get_product_section:[1,1,1,""],get_products_infos:[1,1,1,""],product_compiles:[1,1,1,""],product_has_env_script:[1,1,1,""],product_has_logo:[1,1,1,""],product_has_patches:[1,1,1,""],product_has_salome_gui:[1,1,1,""],product_has_script:[1,1,1,""],product_is_autotools:[1,1,1,""],product_is_cmake:[1,1,1,""],product_is_cpp:[1,1,1,""],product_is_debug:[1,1,1,""],product_is_dev:[1,1,1,""],product_is_fixed:[1,1,1,""],product_is_generated:[1,1,1,""],product_is_mpi:[1,1,1,""],product_is_native:[1,1,1,""],product_is_salome:[1,1,1,""],product_is_sample:[1,1,1,""],product_is_smesh_plugin:[1,1,1,""],product_is_vcs:[1,1,1,""]},"src.pyconf":{Config:[1,2,1,""],ConfigError:[1,4,1,""],ConfigFormatError:[1,4,1,""],ConfigInputStream:[1,2,1,""],ConfigList:[1,2,1,""],ConfigMerger:[1,2,1,""],ConfigOutputStream:[1,2,1,""],ConfigReader:[1,2,1,""],ConfigResolutionError:[1,4,1,""],Container:[1,2,1,""],Expression:[1,2,1,""],Mapping:[1,2,1,""],Reference:[1,2,1,""],Sequence:[1,2,1,""],deepCopyMapping:[1,1,1,""],defaultMergeResolve:[1,1,1,""],defaultStreamOpener:[1,1,1,""],isWord:[1,1,1,""],makePath:[1,1,1,""],overwriteMergeResolve:[1,1,1,""]},"src.pyconf.Config":{Namespace:[1,2,1,""],addNamespace:[1,3,1,""],getByPath:[1,3,1,""],load:[1,3,1,""],removeNamespace:[1,3,1,""]},"src.pyconf.ConfigInputStream":{close:[1,3,1,""],read:[1,3,1,""],readline:[1,3,1,""]},"src.pyconf.ConfigList":{getByPath:[1,3,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[1,3,1,""],merge:[1,3,1,""],mergeMapping:[1,3,1,""],mergeSequence:[1,3,1,""],overwriteKeys:[1,3,1,""]},"src.pyconf.ConfigOutputStream":{close:[1,3,1,""],flush:[1,3,1,""],write:[1,3,1,""]},"src.pyconf.ConfigReader":{getChar:[1,3,1,""],getToken:[1,3,1,""],load:[1,3,1,""],location:[1,3,1,""],match:[1,3,1,""],parseFactor:[1,3,1,""],parseKeyValuePair:[1,3,1,""],parseMapping:[1,3,1,""],parseMappingBody:[1,3,1,""],parseReference:[1,3,1,""],parseScalar:[1,3,1,""],parseSequence:[1,3,1,""],parseSuffix:[1,3,1,""],parseTerm:[1,3,1,""],parseValue:[1,3,1,""],setStream:[1,3,1,""]},"src.pyconf.Container":{evaluate:[1,3,1,""],setPath:[1,3,1,""],writeToStream:[1,3,1,""],writeValue:[1,3,1,""]},"src.pyconf.Expression":{evaluate:[1,3,1,""]},"src.pyconf.Mapping":{addMapping:[1,3,1,""],get:[1,3,1,""],iteritems:[1,3,1,""],iterkeys:[1,3,1,""],keys:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Reference":{addElement:[1,3,1,""],findConfig:[1,3,1,""],resolve:[1,3,1,""]},"src.pyconf.Sequence":{SeqIter:[1,2,1,""],append:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Sequence.SeqIter":{next:[1,3,1,""]},"src.system":{archive_extract:[1,1,1,""],cvs_extract:[1,1,1,""],git_extract:[1,1,1,""],show_in_editor:[1,1,1,""],svn_extract:[1,1,1,""]},"src.template":{MyTemplate:[1,2,1,""],substitute:[1,1,1,""]},"src.template.MyTemplate":{delimiter:[1,5,1,""],pattern:[1,5,1,""]},"src.test_module":{Test:[1,2,1,""],getTmpDirDEFAULT:[1,1,1,""]},"src.test_module.Test":{generate_launching_commands:[1,3,1,""],generate_script:[1,3,1,""],get_test_timeout:[1,3,1,""],get_tmp_dir:[1,3,1,""],prepare_testbase:[1,3,1,""],prepare_testbase_from_dir:[1,3,1,""],prepare_testbase_from_git:[1,3,1,""],prepare_testbase_from_svn:[1,3,1,""],read_results:[1,3,1,""],run_all_tests:[1,3,1,""],run_grid_tests:[1,3,1,""],run_script:[1,3,1,""],run_session_tests:[1,3,1,""],run_testbase_tests:[1,3,1,""],run_tests:[1,3,1,""],search_known_errors:[1,3,1,""],write_test_margin:[1,3,1,""]},"src.xmlManager":{ReadXmlFile:[1,2,1,""],XmlLogFile:[1,2,1,""],add_simple_node:[1,1,1,""],append_node_attrib:[1,1,1,""],find_node_by_attrib:[1,1,1,""],write_report:[1,1,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[1,3,1,""],get_attrib:[1,3,1,""],get_node_text:[1,3,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[1,3,1,""],append_node_attrib:[1,3,1,""],append_node_text:[1,3,1,""],write_tree:[1,3,1,""]},src:{ElementTree:[1,0,0,"-"],__init__:[1,0,0,"-"],architecture:[1,0,0,"-"],colorama:[2,0,0,"-"],compilation:[1,0,0,"-"],debug:[1,0,0,"-"],environment:[1,0,0,"-"],fileEnviron:[1,0,0,"-"],fork:[1,0,0,"-"],logger:[1,0,0,"-"],options:[1,0,0,"-"],printcolors:[1,0,0,"-"],product:[1,0,0,"-"],pyconf:[1,0,0,"-"],system:[1,0,0,"-"],template:[1,0,0,"-"],test_module:[1,0,0,"-"],xmlManager:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:exception","5":"py:attribute"},terms:{"0x36fa5f0":1,"0x37b8f90":1,"0x37f8420":1,"0x44e4620":2,"0x4986ff0":2,"16be":1,"16le":1,"9abc":1,"boolean":[1,18],"case":1,"char":1,"class":[1,2,18],"default":[1,3,5,6,7,9,10,11,12,17,18],"export":12,"final":[1,6,12],"float":1,"function":[1,2,18],"import":[1,7,18],"int":[1,10],"long":[1,4],"new":[1,12,18],"return":[1,7,18],"short":1,"true":[1,2],"try":1,"var":[1,7,18],And:[1,6,7],But:18,CVS:11,For:[1,7,12,14,18],Has:1,One:1,POS:2,The:[1,3,4,5,6,7,8,9,10,11,12,13,14,17,18],Then:[12,13],There:13,These:7,Theses:4,Use:[3,4,5,6,7,8,9,12],Used:1,Useful:17,VCS:[4,11],__init__:1,__save__:1,__setattr__:1,_appli:3,_blank:1,_build:7,_debug:1,_launch:7,_ld_library_path:7,_sre:[1,2],a_b_c_:1,abool:1,about:[1,13],absolut:11,access:[1,2,10],account:7,act:[1,2],action:1,activ:[1,12],activate_mesa_properti:1,actual:[1,2,15],add:[1,5,14],add_com:1,add_echo:1,add_lin:1,add_link:1,add_opt:[1,18],add_simple_nod:1,add_warn:1,added:1,addel:1,adding:18,addit:[1,5,13],additional_dir:1,additional_env:1,addmap:1,addnamespac:1,adequ:1,adot:1,advanc:1,affect:2,afil:1,after:[1,5,15],again:1,agent:12,aim:1,algorithm:18,all:[1,2,4,6,7,8,12,13,17,18],all_in_termin:1,allow:[1,5,6,8,14,17],alphanumer:1,alreadi:[11,18],also:[1,7,12,13,18],alter:12,amethodtodebug:1,amount:1,ani:[1,2,6,10,12],anoth:[1,13],ansi:[0,1],ansi_csi_r:2,ansi_escape_cod:2,ansi_osc_r:2,ansiback:2,ansicod:2,ansicursor:2,ansifor:2,ansistyl:2,ansitowin32:[0,1],apart:2,api:1,append:[1,7,11],append_node_attrib:1,append_node_text:1,append_valu:1,appli:[1,6,8,12],applic:[1,4,5,6,7,8,9,10,12,14,18],application_nam:3,appropri:1,arch:11,architectur:[0,11,13],archiv:[1,11,12],archive_extract:1,archive_info:12,arg:[1,2,18],arglist:1,argument:[1,18],ascii:1,ask:1,assign:1,assum:1,astream:1,atitl:1,attibut:1,attr:[1,2],attrib:1,attribut:[1,2],authent:12,author:1,automat:[6,7],autoreset:2,autotool:[1,5],avail:6,avari:1,avoid:12,award:1,back:2,backtick:1,base:[1,2,13],bash:[1,7,12],bashfileenviron:1,bat:[1,7],batch:1,batch_salom:1,batfileenviron:1,becaus:1,been:[1,2],befor:[1,5],begin:1,behavior:18,being:1,belong:1,below:7,between:[1,18],bienvenu:1,big:5,bigger:1,bin:7,binari:11,black:2,blogmatrix:1,blue:2,bom:1,bonjour:18,bool:1,both:[1,7,8],bracket:1,branch:12,bright:2,bright_background:2,bring:[8,12],browser:[1,6,10,13],buf:1,build:[1,4,5,7,13],build_conf_opt:1,build_configur:1,build_sourc:5,builder:1,built:1,call:[1,2,7,9,18],call_win32:2,callabl:1,can:[1,3,7,12,13,14,18],cannot:1,care:4,carri:1,catalog:[3,9],cfg:[1,7,18],cfg_env:1,cfgforpi:1,chang:[1,3,17,18],change_to_launch:1,charact:[1,2],charg:9,check:[1,5,7],check_config_exist:1,check_config_has_appl:1,check_config_has_profil:1,check_instal:1,check_sourc:1,check_src:1,checkout:[1,12],chmod:1,choic:6,circumst:1,clash:1,classic:1,clean:[1,5,10,14],clean_al:[5,17],clean_build_aft:5,clean_instal:5,cleancolor:1,clear_lin:2,clear_screen:2,cli:[10,17],cli_:18,client:1,clone:12,close:1,closest:1,cmake:[1,5],cmake_opt:5,cmd:1,co7:11,code:[1,2,7],code_to_char:2,color:[1,2],colorama:[0,1],colorama_text:2,column:1,com:1,come:6,command:[1,2,13,15,17],command_nam:1,command_opt:17,command_r:1,command_valu:1,comment:[1,13],commentari:1,commit:4,common:1,commonli:1,compat:1,compil:[0,7,8,10,12,14],compil_script:5,complementari:7,complet:[5,6,12,13],complete_environ:1,compon:[1,3,8],componon:8,compress:11,comput:[1,8,11],concaten:1,concern:12,config:[1,12,13,14,17],config_has_appl:1,configerror:1,configformaterror:1,configinputstream:1,configlist:1,configmerg:1,configoutputstream:1,configread:1,configresolutionerror:1,configur:[1,14,18],configure_opt:1,configut:3,conflict:1,conform:8,consist:1,consol:1,construct:[1,14,16],contain:[1,13,18],context:[1,17],contextfileenviron:1,continu:1,control:11,convert:2,convert_ansi:2,convert_osc:2,copi:[1,3,6,9,17],copydir:1,copyfil:1,copylink:1,copyright:1,corba:8,correct:1,correl:1,correspond:[1,7,10,12],could:[1,4,7,15],cpp:[1,8],creat:[1,3,4,7,9,11,12,13,14],creation:11,current:[1,6,13,17,18],cursor_adjust:2,cvs:1,cvs_extract:1,cvs_info:12,cvspass:12,cwd:1,cyan:2,dai:1,data:[1,6,18],date:[1,13],date_to_datetim:1,datetim:1,david:1,dbg:1,debug:[0,6,7,12],decid:1,declar:12,deep:1,deepcopy_list:1,deepcopymap:1,def:[1,7,18],default_valu:1,defaultmergeresolv:1,defaultstreamopen:1,defin:[1,4,5,6,7,8,13,18],definit:1,deinit:2,delai:1,delaiapp:1,deleg:2,delet:11,delimit:1,delta:1,depend:[1,5,11],deriv:1,describ:1,descript:[1,18],design:1,destnam:1,detail:1,detar:15,detect:1,determin:1,dev:1,develop:[1,4,6,7,12,18],dict:1,dict_arg:1,dictionari:[1,13],differ:7,dim:2,dir:[1,6,12],dir_info:12,directli:[7,10,15],directori:[1,3,4,5,6,7,9,10,11,12,13,15,17,18],dirpath:1,displai:[1,5,6,10,18],distant:3,distinguish:7,distrib:1,distribut:[1,3,8],divis:1,dixt:1,do_batch_script_build:1,do_default_build:1,do_python_script_build:1,do_script_build:1,doctyp:1,document:[8,13,18],doe:[1,7,12],dollar:1,don:8,done:[7,17],dot:1,dove:1,down:2,download:[1,12],drive:1,dst:1,due:1,dump:1,duplic:5,dure:12,dynam:13,each:[1,3,9,12,13],earlier:1,earliest:1,echo:1,edit:[6,12],editor:[1,6,13],eearch:1,either:[1,7],eleg:1,elem:1,element:1,element_factori:1,elementtre:0,els:[1,18],embed:11,empti:1,enable_simple_env_script:1,enclos:1,encod:1,end:[1,2,7],end_writ:1,ensur:1,ensure_path_exist:1,entri:1,env:7,env_build:7,env_info:1,env_launch:7,env_script:7,environ:[0,8,13,14],equal:5,eras:10,erase_lin:2,erase_screen:2,error:1,etc:[1,13,14],etre:1,eval:1,evalu:1,event:1,everyth:5,exactli:1,exampl:[1,4,5,6,7,11,12,14,17],exc:1,except:[1,12,17],execut:[1,5,12,17],exhaust:[13,17],exist:[1,11,12,17],exot:1,expect:1,explain:7,explicitli:1,explor:6,express:[1,6],extens:[1,18],extra:1,extract:1,extract_param:2,fact:18,factor:1,factori:1,fail:[1,5],fals:[1,2],far:1,favorit:6,feed:1,field:1,file:[1,3,5,6,7,9,10,11,12,13,14,18],file_nam:1,file_path:1,fileenviron:0,fileenvwrit:1,filein:1,filenam:1,filepath:1,filter:4,fin:1,find:[1,6,14,15],find_file_in_lpath:1,find_node_by_attrib:1,findal:1,findconfig:1,findtext:1,finish:1,firefox:[10,13],first:[1,7,12,18],fix:1,flag:5,flush:1,fmt:1,follow:[1,7,18],for_packag:1,forbuild:1,forc:[1,11,12],force_patch:12,fore:2,forget:1,fork:0,form:1,format:[1,7,13],forward:[2,3,9],found:1,four:7,french:18,from:[1,2,6,7,8,11,12,18],from_what:1,fromstr:1,full:1,full_launched_command:1,fun:6,func:1,futur:1,gdb:7,gencat:[3,9],gener:[1,2,3,7,9,14,17],generate_launching_command:1,generate_script:1,generic_opt:17,geom:5,get:[1,6,12,13,18],get_attr:2,get_attrib:1,get_base_install_dir:1,get_base_path:1,get_cfg_param:1,get_distrib_vers:1,get_distribut:1,get_file_environ:1,get_install_dir:1,get_launcher_nam:1,get_log_path:1,get_method:12,get_nam:1,get_nb_proc:1,get_node_text:1,get_posit:2,get_product_compon:1,get_product_config:1,get_product_depend:1,get_product_sect:1,get_products_info:1,get_property_in_product_cfg:1,get_python_vers:1,get_salome_vers:1,get_test_timeout:1,get_tmp_dir:1,get_tmp_filenam:1,get_us:1,get_win32_cal:2,getbypath:1,getchar:1,getiter:1,getlocalenv:1,getroot:1,getrootattrib:1,getstrconfigdbg:1,getstrconfigstd:1,gettmpdir:1,gettmpdirdefault:1,gettoken:1,git:[1,11],git_extract:1,git_info:12,gitconfig:12,give:[1,3,13,18],given:[1,2,3,7,9],global:1,goe:1,green:2,grei:2,grep:6,grid:1,gui:1,hack_libtool:1,had:1,handl:[1,2,7],handlemismatch:1,handleremovereadonli:1,hard:1,harri:1,has:[1,2,7,18],has_salome_hui:1,has_timed_out:1,hat:1,have:[1,3,4,8,9,12],header:1,help:[1,18],helpstr:1,here:[1,7,13,18],hierarchi:1,highlight:1,himself:7,hold:9,home:6,hour:1,how:[1,7,12,13],html:1,http:[1,2],hxx2salom:8,ident:1,identifi:1,ignor:[1,8],ignorelist:1,imag:12,implement:[1,2,7],includ:[1,7,11,13],indent:1,index:1,indic:1,indirect:1,info:[1,6,12],inform:[1,6,11,12,13],init:[1,2],initi:1,initialis:[0,1],inmap:1,input:1,input_list:1,insid:12,instal:[1,4,5,13,14,17],install_dir:7,instanc:[1,2,18],instanti:1,instead:1,instream:1,instruct:[1,13],intal:11,interact:10,interfac:[1,17],intern:1,invalid:1,ioerror:1,iostream:1,is_a_tti:2,is_defin:1,is_salome_modul:[4,7],is_stream_clos:2,is_window:1,isdir:1,isel:1,isfil:1,islink:1,issu:2,isword:1,item:1,iter:1,iteritem:1,iterkei:1,iterpars:1,its:[1,5,6,7,13],ivar:1,jane:1,job:5,join:7,just:[1,5],keep:1,kei:[1,7,12],kernel:[6,17],killsalom:1,know:[1,12],known:11,kwarg:2,kwd:2,label:[1,6],lanch:1,lapack:7,lapack_root_dir:7,last:[1,7,10],last_termin:10,later:11,latter:1,launch:[1,7],launch_command:1,launcher:[1,3,7,14],launcher_nam:9,launcherfileenviron:1,layer:8,ld_library_path:7,left:7,level:[1,17,18],lhs:1,lib:7,librari:1,light:2,lightblack_ex:2,lightblue_ex:2,lightcyan_ex:2,lightgreen_ex:2,lightmagenta_ex:2,lightred_ex:2,lightwhite_ex:2,lightyellow_ex:2,like:[1,2,3,5,6,9,13],line:[1,6,17],link:[1,12],list:[1,3,4,6,9,13],list_log_fil:1,list_of_product:8,listtest:1,llvm:[3,9],load:[1,13],load_cfg_environ:1,load_environ:1,local:6,locat:1,log:[1,5,14,18],log_command:1,log_dir:10,log_file_nam:1,logdir:1,logfilepath:1,logger:0,login:12,logo:[1,9],lome:14,longnam:1,lost:1,lpath:1,lproduct:1,machin:[1,3,8,9,11],machine1:3,machine2:3,machine3:3,magenta:2,mai:12,main:5,make:[1,5],make_flag:5,make_opt:1,makepath:1,manag:[1,6,12],manipul:[1,6],map1:1,map2:1,map:1,match:1,max:1,mechan:[1,7],med:5,memori:[3,9],menu:10,merg:1,merge:1,merge_dict:1,mergemap:1,mergesequ:1,mesa:[1,3,9],messag:[1,18],method:[1,2,5,7,12,18],micro_command:1,minim:1,minut:1,mismatch:1,miss:[3,5],mistak:12,mode:[1,2,4,6,7,10,17],model:18,modifi:[1,7,12],modul:[0,3,5,8,9,12,13,14],mon:1,mond:18,more:[1,17],most:[1,7,18],multi:1,multilin:1,multipl:1,must:[1,18],my_application_directori:3,my_application_nam:3,my_tag:12,mycommand:18,mydebug:1,myoption:18,myspecificnam:11,mytempl:1,name:[1,3,4,6,7,9,11,12,13,17,18],name_nod:1,namespac:1,nativ:[1,7],nb_line:1,nb_proc:[1,5],need:[1,2,3,8,12],new_nam:6,next:1,nfirst:1,no_label:6,node:1,node_nam:1,non:2,none:[1,2],nor:2,normal:[1,2],note:[1,3,7,9,13],noth:[1,11],notimplementederror:1,notion:1,notshowncommand:1,number:[1,3,5,9,10],number_of_proc:1,obj1:1,obj2:1,object:[1,2,13],obtain:1,obvious:1,occur:1,ode:1,old:1,older:10,on_stderr:2,onc:12,one:[1,6],onli:[1,3,4,5,6,7,8,9,10,12,17],only_numb:1,ool:14,open:1,openggl:[3,9],openmpi:1,oper:[1,6,14],operand:1,opt_nb_proc:1,option:[0,2,3,5,6,7,8,9,10,11,12,13,18],optionali:1,optiontyp:1,optresult:1,order:[1,12,13,18],org:2,other:[1,7,11,13],otherwis:[1,12],our:2,out:1,out_dir:1,output:[1,2],outstream:1,overrid:[1,3],overwrit:1,overwritekei:1,overwritemergeresolv:1,overwritten:1,own:1,packag:[0,14,15],page:7,pair:1,param:[1,2],param_nam:1,paramet:[1,6,13,18],parameter_path:6,paramstr:2,paravi:[3,9],parent:1,parma:1,pars:[1,18],parse_arg:[1,18],parse_d:1,parsefactor:1,parsekeyvaluepair:1,parsemap:1,parsemappingbodi:1,parser:[1,18],parserefer:1,parsescalar:1,parsesequ:1,parsesuffix:1,parseterm:1,parsevalu:1,part:[1,3,7,9],particular:1,pass:[1,13,18],passphras:12,password:12,patch:[1,6,12],path:[1,7,9],path_to_catalog:3,path_to_yacsgen:8,pattern:1,pdf:[6,14],pend:4,pendant:1,perform:[12,14],person:6,phase:1,platform:[2,7],pleas:[7,8],plugin:[1,5],pluma:13,point:[1,18],pop_debug:1,popul:1,posit:2,possibl:[1,7,12,18],potenti:1,pprty:1,preced:1,prefer:[6,13],prefix:[1,7,13],prepar:[1,14,18],prepare_testbas:1,prepare_testbase_from_dir:1,prepare_testbase_from_git:1,prepare_testbase_from_svn:1,prepend:[1,7],prepend_valu:1,prereq_dir:7,prerequisit:[7,11,13,14,17],presenc:1,preset:1,pretti:1,previou:1,previous:4,print:[1,2,6,10],print_color_map:1,print_color_rang:1,print_help:1,print_info:1,print_valu:1,printc:1,printcerror:1,printchead:1,printchighlight:1,printcinfo:1,printclabel:1,printcolor:0,printcsuccess:1,printcwarn:1,problem:[1,3,9],procedur:1,process:12,processinginstruct:1,processor:[1,3,9],prod_dir:1,prod_info:1,produc:1,product1:[5,7,12],product2:[5,7,12],product:[0,4,5,6,7,8,9,11,12,14,18],product_cfg:1,product_compil:1,product_has_env_script:1,product_has_logo:1,product_has_patch:1,product_has_salome_gui:1,product_has_script:1,product_info:1,product_is_autotool:1,product_is_cmak:1,product_is_cpp:1,product_is_debug:1,product_is_dev:1,product_is_fix:1,product_is_gener:1,product_is_mpi:1,product_is_n:1,product_is_salom:1,product_is_sampl:1,product_is_smesh_plugin:1,product_is_vc:1,product_nam:1,profil:[1,9],program:1,programmat:7,progress:1,project:[6,7],properti:[1,4,7,8],protocol:[1,3],provid:[1,7,18],proxi:2,pubid:1,push:12,push_debug:1,put:1,put_initial_xml_field:1,put_txt_log_in_appli_log_dir:1,pv_plugin_path:1,pwd:1,pyconf:[0,5,6,7,12,13,18],python:[1,7,9,13,14,15,18],python_config:1,pythonpath:7,pythonpath_:7,qname:1,queri:[3,9],rais:[1,17],rang:1,raw:1,read:1,read_config_from_a_fil:1,read_result:1,reader:1,readi:12,readlin:1,readlink:1,readxmlfil:1,recurs:[1,6],red:[1,2],redefin:1,redirect:1,ref:1,refer:[1,8,13],reflect:1,regard:1,regular:1,reinit:[1,2],rel:[1,11],remain:[10,15],remark:3,remor:8,remot:[1,11],remov:[1,4,5,12],remove_item_from_list:1,removenamespac:1,renam:1,renint:1,replac:[1,3],replace_in_fil:1,report:1,repositori:[1,12],repres:1,represent:1,request:2,requir:[1,2,7,8],reserv:1,reset:2,reset_al:2,resolut:1,resolv:1,resourc:[3,9],respect:7,restor:[1,4],result:1,retriev:1,rhs:1,right:[1,7],root:[1,18],root_nod:1,rootnam:1,rtype:1,run:[1,7,13,14,18],run_all_test:1,run_env_script:1,run_grid_test:1,run_script:1,run_session_test:1,run_simple_env_script:1,run_test:1,run_testbase_test:1,runappli:3,runner:18,ruud:1,sajip:1,salom:[1,3,4,5,6,7,8,9,11,13,15],salome_modul:1,salome_session_serv:1,salome_xx:[4,11,15,17],salome_xx_:11,salomecontext:1,salomeenviron:1,salometool:[1,3,6,7,11,13,14,15],same:1,sampl:[1,17],sat:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,18],satexcept:1,save:7,saveconfigdbg:1,saveconfigstd:1,scalar:1,screenenviron:1,screenonli:1,script:[1,5,6,7,9,13,14,15],script_nam:1,script_path:1,search:1,search_known_error:1,second:[1,7,18],section:[1,3,7,12],secur:12,see:[1,2,13,17],seen:1,select:11,self:1,semant:1,sep:[1,7],separ:1,seq1:1,seq2:1,seq:1,seqit:1,sequenc:[1,2],server:[1,12],servic:18,session:1,set:[1,3,4,7,9,13,14,18],set_a_product:1,set_application_env:1,set_attr:2,set_consol:2,set_cpp_env:1,set_cursor_posit:2,set_env:[1,7],set_env_build:7,set_env_launch:7,set_full_environ:1,set_native_env:[1,7],set_product:1,set_python_libdir:1,set_salome_generic_product_env:1,set_salome_minimal_product_env:1,set_titl:2,setconsoletextattribut:2,setpath:1,setstream:1,sever:[7,13],shallow:1,shell:[1,7],shortcut:1,shortnam:1,should:[1,7,8],should_wrap:2,show:[1,5,10],show_command_log:1,show_desktop:1,show_in_editor:1,show_patch:6,show_progress:1,show_warn:1,showinfo:1,shown:[1,5],sign:1,silent_sysstd:1,similar:1,simpl:[1,17,18],sinc:1,site:1,size:1,smaller:1,smart:1,smartcopi:1,smesh:1,softwar:12,some:[1,7,9,13,18],someon:7,sometim:4,sommeil:1,soon:5,sourc:[1,2,4,6,11,12],sources_without_dev:4,special_path_separ:1,specif:[1,3,4,7,8,9,11,13,17],specifi:[1,3,7,8,9,12],splashscreen:9,src:[2,18],src_root:1,sre_pattern:[1,2],ssh:[3,9,12],stack:17,start:[1,2,3,5,9],statu:1,stderr:1,stdout:[1,2],step:1,stop:5,stop_first_fail:5,store:[1,5,6,10,12,13],str:1,str_num:1,stream:[1,2],streamopen:1,streamorfil:1,streamwrapp:2,strin:1,string:1,stringio:1,strip:2,strout:1,structur:13,stuff:[1,9],style:[1,2],stylesheet:1,sub:[1,13],subclass:1,subel:1,subpackag:0,subsect:7,subset:11,subst_dic:1,substitut:1,subtract:1,success:[1,5],successfulli:1,suffici:7,suffix:1,suit:14,suitabl:1,support:1,supposedli:1,suppress:4,svn:[1,11],svn_extract:1,svn_info:12,symlink:1,syntax:[1,4],sys:1,system:[0,11],tab:1,tabl:1,tag:[1,12],take:[1,4],taken:[1,7],tar:[11,15],target:[1,3,7],tcllibpath:1,templat:0,template_fil:1,temporari:1,term:1,termin:[1,2,5,10,18],test:[1,5,14],test_base_nam:1,test_config:1,test_grid:1,test_modul:0,test_nam:1,test_sess:1,testbas:1,testbase_bas:1,testbase_dir:1,testbase_nam:1,testbase_tag:1,text:[1,2,17],text_or_uri:1,tgz:[11,15],thank:1,thei:[4,6,7,12],them:[2,12],thi:[1,2,3,5,6,7,8,9,11,12,13,14,18],thing:18,those:8,through:[3,7,9,10],thrown:1,time:[1,4,7,12,13],timedelta:1,timedelta_total_second:1,titl:[1,2],tklibpath:1,tmp_working_dir:1,tofix:1,token:1,token_typ:1,token_valu:1,top:1,tostr:1,total_second:1,tout:18,trace:17,transform:1,transpar:2,tree:1,treebuild:1,trust_root_dir:7,tty:2,tupl:1,turn:1,tutori:1,two:[1,7],txt:1,type:[1,12],typeerror:1,unabl:1,unchang:1,unconditionali:[1,17],under:[1,14],underscor:[1,7],unicod:1,unit:5,unless:[2,12],updat:1,update_hat_xml:1,updatehatxml:1,urllib2:1,urlopen:1,usag:[1,14],use:[1,3,5,7,9,10,11,12,13,15],use_mesa:[3,9],used:[1,3,5,6,7,10,11,12,13,14],useful:[7,9,18],user:[1,6,7,10,11,15,17],usernam:1,uses:[1,7,8,12,13],using:[1,2,8],usr:7,usual:[4,8,11,13,15,17],utf:[1,7],util:[1,11,14],valid:1,valu:[1,2,3,4,6,12,13],variabl:[1,7,8,18],vcs:1,verbos:[1,18],verifi:[1,12],version:[1,7,8,11,13,14],via:1,viewer:6,vinai:1,virtual:[1,3],virtual_app:3,visualis:7,wai:[1,5,18],want:[1,4,7,18],warn:[1,5],web:[6,10,13],welcom:1,welkom:1,well:1,were:1,what:[1,4],when:[1,3,7,12,13,18],whenev:1,where:[1,3,5,6,11],which:[1,2,7,8,13,18],white:2,who:8,wiki:2,wikipedia:2,wil:7,win32:[0,1],winapi_test:2,wincolor:2,window:[1,2,7],winstyl:2,winterm:[0,1],with_children:5,with_commerci:1,with_fath:5,with_install_dir:1,with_vc:11,within:7,without:[1,6,12],without_properti:11,wmake:1,word:1,work:[1,6,11,12,13],workdir:[1,3,6,9,11,13,17,18],world:18,would:1,wrap:2,wrap_stream:2,writabl:1,write:[1,2,18],write_and_convert:2,write_back:1,write_cfgforpy_fil:1,write_env_fil:1,write_plain_text:2,write_report:1,write_test_margin:1,write_tre:1,writetostream:1,writevalu:1,written:18,www:1,xa4:1,xc2:1,xml:[1,18],xmllogfil:1,xmlmanag:0,xmlroot:1,xmltreebuild:1,xxx:[4,13],xxx_root_dir:1,xxx_src_dir:1,yacsgen:[1,8],yacsgen_root_dir:8,year:1,yellow:2,yes:[1,4,7,8,12],yet:17,yield:1,you:[1,3,4,7,9,12,14,18],your:[1,7,12,17,18],yourspecificnam:11,yve:1,yyi:13,yyyi:1,yyyymmdd_hhmmss:1,yyyymmdd_hhmmss_namecmd:1,zelaunch:9,zero:1,zerodivideerror:1},titles:["src","src Package","colorama Package","Command application","Command clean","Command compile","Command config","Command environ","Command generate","Command launcher","Command log","Command package","Command prepare","Configuration","Salome Tools","Installation","Release notes","Usage of SAlomeTools","Add a user custom command"],titleterms:{"var":13,VCS:12,access:18,add:18,ansi:2,ansitowin32:2,applic:[3,13],architectur:1,avail:[4,17],base:12,basic:18,build:17,clean:4,code:14,colorama:2,command:[3,4,5,6,7,8,9,10,11,12,14,18],compil:[1,5,17],config:[6,18],configur:[3,4,5,6,7,9,10,11,12,13],custom:18,cvs:12,debug:[1,17],descript:[3,4,5,6,7,8,9,10,11,12,13],dev:12,develop:14,document:14,elementtre:1,environ:[1,7],exampl:18,fileenviron:1,fork:1,gener:8,get:17,git:12,hello:18,help:17,howto:18,initialis:2,instal:15,introduct:18,launcher:9,list:[14,17],log:10,logger:[1,18],mode:12,modul:[1,2],note:[14,16],option:[1,4,17],other:18,packag:[1,2,11],path:[3,4,5,6,10,11,12],prepar:[12,17],printcolor:1,product:[1,13,17],pyconf:1,quick:14,releas:[14,16],remark:[8,12],requir:18,salom:[14,17],salometool:[17,18],sat:17,section:13,some:[3,4,5,6,10,11,12],sourc:17,src:[0,1],start:14,subpackag:1,svn:12,syntax:13,system:1,templat:1,test_modul:1,tool:14,usag:[3,4,5,6,7,8,9,10,11,12,17],useful:[3,4,5,6,10,11,12],user:[13,18],verbos:17,win32:2,winterm:2,xmlmanag:1}})
\ No newline at end of file
+Search.setIndex({docnames:["commands/apidoc/modules","commands/apidoc/src","commands/apidoc/src.colorama","commands/application","commands/clean","commands/compile","commands/config","commands/doc","commands/environ","commands/generate","commands/launcher","commands/log","commands/package","commands/prepare","configuration","index","installation_of_sat","release_notes/release_notes_5.0.0","usage_of_sat","write_command"],envversion:52,filenames:["commands/apidoc/modules.rst","commands/apidoc/src.rst","commands/apidoc/src.colorama.rst","commands/application.rst","commands/clean.rst","commands/compile.rst","commands/config.rst","commands/doc.rst","commands/environ.rst","commands/generate.rst","commands/launcher.rst","commands/log.rst","commands/package.rst","commands/prepare.rst","configuration.rst","index.rst","installation_of_sat.rst","release_notes/release_notes_5.0.0.rst","usage_of_sat.rst","write_command.rst"],objects:{"":{src:[1,0,0,"-"]},"src.ElementTree":{Comment:[1,1,1,""],Element:[1,1,1,""],ElementTree:[1,2,1,""],PI:[1,1,1,""],ProcessingInstruction:[1,1,1,""],QName:[1,2,1,""],SubElement:[1,1,1,""],TreeBuilder:[1,2,1,""],XML:[1,1,1,""],XMLTreeBuilder:[1,2,1,""],dump:[1,1,1,""],fromstring:[1,1,1,""],iselement:[1,1,1,""],iterparse:[1,2,1,""],parse:[1,1,1,""],tostring:[1,1,1,""]},"src.ElementTree.ElementTree":{find:[1,3,1,""],findall:[1,3,1,""],findtext:[1,3,1,""],getiterator:[1,3,1,""],getroot:[1,3,1,""],parse:[1,3,1,""],write:[1,3,1,""]},"src.ElementTree.TreeBuilder":{close:[1,3,1,""],data:[1,3,1,""],end:[1,3,1,""],start:[1,3,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[1,3,1,""],doctype:[1,3,1,""],feed:[1,3,1,""]},"src.ElementTree.iterparse":{next:[1,3,1,""]},"src.Path":{base:[1,3,1,""],chmod:[1,3,1,""],copy:[1,3,1,""],copydir:[1,3,1,""],copyfile:[1,3,1,""],copylink:[1,3,1,""],dir:[1,3,1,""],exists:[1,3,1,""],isdir:[1,3,1,""],isfile:[1,3,1,""],islink:[1,3,1,""],list:[1,3,1,""],make:[1,3,1,""],readlink:[1,3,1,""],rm:[1,3,1,""],smartcopy:[1,3,1,""],symlink:[1,3,1,""]},"src.architecture":{get_distrib_version:[1,1,1,""],get_distribution:[1,1,1,""],get_nb_proc:[1,1,1,""],get_python_version:[1,1,1,""],get_user:[1,1,1,""],is_windows:[1,1,1,""]},"src.colorama":{ansi:[2,0,0,"-"],ansitowin32:[2,0,0,"-"],initialise:[2,0,0,"-"],win32:[2,0,0,"-"],winterm:[2,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[2,2,1,""],AnsiCodes:[2,2,1,""],AnsiCursor:[2,2,1,""],AnsiFore:[2,2,1,""],AnsiStyle:[2,2,1,""],clear_line:[2,1,1,""],clear_screen:[2,1,1,""],code_to_chars:[2,1,1,""],set_title:[2,1,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[2,3,1,""],DOWN:[2,3,1,""],FORWARD:[2,3,1,""],POS:[2,3,1,""],UP:[2,3,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[2,5,1,""],DIM:[2,5,1,""],NORMAL:[2,5,1,""],RESET_ALL:[2,5,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[2,2,1,""],StreamWrapper:[2,2,1,""],is_a_tty:[2,1,1,""],is_stream_closed:[2,1,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[2,5,1,""],ANSI_OSC_RE:[2,5,1,""],call_win32:[2,3,1,""],convert_ansi:[2,3,1,""],convert_osc:[2,3,1,""],extract_params:[2,3,1,""],get_win32_calls:[2,3,1,""],reset_all:[2,3,1,""],should_wrap:[2,3,1,""],write:[2,3,1,""],write_and_convert:[2,3,1,""],write_plain_text:[2,3,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[2,3,1,""]},"src.colorama.initialise":{colorama_text:[2,1,1,""],deinit:[2,1,1,""],init:[2,1,1,""],reinit:[2,1,1,""],reset_all:[2,1,1,""],wrap_stream:[2,1,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[2,1,1,""],winapi_test:[2,1,1,""]},"src.colorama.winterm":{WinColor:[2,2,1,""],WinStyle:[2,2,1,""],WinTerm:[2,2,1,""]},"src.colorama.winterm.WinColor":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],GREY:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[2,5,1,""],BRIGHT_BACKGROUND:[2,5,1,""],NORMAL:[2,5,1,""]},"src.colorama.winterm.WinTerm":{back:[2,3,1,""],cursor_adjust:[2,3,1,""],erase_line:[2,3,1,""],erase_screen:[2,3,1,""],fore:[2,3,1,""],get_attrs:[2,3,1,""],get_position:[2,3,1,""],reset_all:[2,3,1,""],set_attrs:[2,3,1,""],set_console:[2,3,1,""],set_cursor_position:[2,3,1,""],set_title:[2,3,1,""],style:[2,3,1,""]},"src.compilation":{Builder:[1,2,1,""]},"src.compilation.Builder":{build_configure:[1,3,1,""],check:[1,3,1,""],cmake:[1,3,1,""],complete_environment:[1,3,1,""],configure:[1,3,1,""],do_batch_script_build:[1,3,1,""],do_default_build:[1,3,1,""],do_python_script_build:[1,3,1,""],do_script_build:[1,3,1,""],hack_libtool:[1,3,1,""],install:[1,3,1,""],log:[1,3,1,""],log_command:[1,3,1,""],make:[1,3,1,""],prepare:[1,3,1,""],put_txt_log_in_appli_log_dir:[1,3,1,""],wmake:[1,3,1,""]},"src.debug":{InStream:[1,2,1,""],OutStream:[1,2,1,""],getLocalEnv:[1,1,1,""],getStrConfigDbg:[1,1,1,""],getStrConfigStd:[1,1,1,""],indent:[1,1,1,""],pop_debug:[1,1,1,""],push_debug:[1,1,1,""],saveConfigDbg:[1,1,1,""],saveConfigStd:[1,1,1,""],tofix:[1,1,1,""],write:[1,1,1,""]},"src.debug.OutStream":{close:[1,3,1,""]},"src.environment":{Environ:[1,2,1,""],FileEnvWriter:[1,2,1,""],SalomeEnviron:[1,2,1,""],Shell:[1,2,1,""],load_environment:[1,1,1,""]},"src.environment.Environ":{append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[1,3,1,""],write_env_file:[1,3,1,""]},"src.environment.SalomeEnviron":{add_comment:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],dump:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],get_names:[1,3,1,""],is_defined:[1,3,1,""],load_cfg_environment:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],run_simple_env_script:[1,3,1,""],set:[1,3,1,""],set_a_product:[1,3,1,""],set_application_env:[1,3,1,""],set_cpp_env:[1,3,1,""],set_full_environ:[1,3,1,""],set_products:[1,3,1,""],set_python_libdirs:[1,3,1,""],set_salome_generic_product_env:[1,3,1,""],set_salome_minimal_product_env:[1,3,1,""]},"src.fileEnviron":{BashFileEnviron:[1,2,1,""],BatFileEnviron:[1,2,1,""],ContextFileEnviron:[1,2,1,""],FileEnviron:[1,2,1,""],LauncherFileEnviron:[1,2,1,""],ScreenEnviron:[1,2,1,""],get_file_environ:[1,1,1,""],special_path_separator:[1,1,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[1,3,1,""],finish:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[1,3,1,""],add_warning:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[1,3,1,""],add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],change_to_launcher:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],set:[1,3,1,""],write:[1,3,1,""]},"src.fork":{batch:[1,1,1,""],batch_salome:[1,1,1,""],launch_command:[1,1,1,""],show_progress:[1,1,1,""],write_back:[1,1,1,""]},"src.logger":{Logger:[1,2,1,""],date_to_datetime:[1,1,1,""],list_log_file:[1,1,1,""],show_command_log:[1,1,1,""],timedelta_total_seconds:[1,1,1,""],update_hat_xml:[1,1,1,""]},"src.logger.Logger":{add_link:[1,3,1,""],end_write:[1,3,1,""],error:[1,3,1,""],flush:[1,3,1,""],put_initial_xml_fields:[1,3,1,""],write:[1,3,1,""]},"src.options":{OptResult:[1,2,1,""],Options:[1,2,1,""]},"src.options.Options":{add_option:[1,3,1,""],debug_write:[1,3,1,""],filterLevel:[1,3,1,""],filterList2:[1,3,1,""],getDetailOption:[1,3,1,""],get_help:[1,3,1,""],indent:[1,3,1,""],parse_args:[1,3,1,""],print_help:[1,3,1,""]},"src.printcolors":{cleancolor:[1,1,1,""],print_color_map:[1,1,1,""],print_color_range:[1,1,1,""],print_value:[1,1,1,""],printc:[1,1,1,""],printcError:[1,1,1,""],printcHeader:[1,1,1,""],printcHighlight:[1,1,1,""],printcInfo:[1,1,1,""],printcLabel:[1,1,1,""],printcSuccess:[1,1,1,""],printcWarning:[1,1,1,""]},"src.product":{check_config_exists:[1,1,1,""],check_installation:[1,1,1,""],check_source:[1,1,1,""],get_base_install_dir:[1,1,1,""],get_install_dir:[1,1,1,""],get_product_components:[1,1,1,""],get_product_config:[1,1,1,""],get_product_dependencies:[1,1,1,""],get_product_section:[1,1,1,""],get_products_infos:[1,1,1,""],product_compiles:[1,1,1,""],product_has_env_script:[1,1,1,""],product_has_logo:[1,1,1,""],product_has_patches:[1,1,1,""],product_has_salome_gui:[1,1,1,""],product_has_script:[1,1,1,""],product_is_autotools:[1,1,1,""],product_is_cmake:[1,1,1,""],product_is_cpp:[1,1,1,""],product_is_debug:[1,1,1,""],product_is_dev:[1,1,1,""],product_is_fixed:[1,1,1,""],product_is_generated:[1,1,1,""],product_is_mpi:[1,1,1,""],product_is_native:[1,1,1,""],product_is_salome:[1,1,1,""],product_is_smesh_plugin:[1,1,1,""],product_is_vcs:[1,1,1,""],product_is_verbose:[1,1,1,""]},"src.pyconf":{Config:[1,2,1,""],ConfigError:[1,4,1,""],ConfigFormatError:[1,4,1,""],ConfigInputStream:[1,2,1,""],ConfigList:[1,2,1,""],ConfigMerger:[1,2,1,""],ConfigOutputStream:[1,2,1,""],ConfigReader:[1,2,1,""],ConfigResolutionError:[1,4,1,""],Container:[1,2,1,""],Expression:[1,2,1,""],Mapping:[1,2,1,""],Reference:[1,2,1,""],Sequence:[1,2,1,""],deepCopyMapping:[1,1,1,""],defaultMergeResolve:[1,1,1,""],defaultStreamOpener:[1,1,1,""],isWord:[1,1,1,""],makePath:[1,1,1,""],overwriteMergeResolve:[1,1,1,""]},"src.pyconf.Config":{Namespace:[1,2,1,""],addNamespace:[1,3,1,""],getByPath:[1,3,1,""],load:[1,3,1,""],removeNamespace:[1,3,1,""]},"src.pyconf.ConfigInputStream":{close:[1,3,1,""],read:[1,3,1,""],readline:[1,3,1,""]},"src.pyconf.ConfigList":{getByPath:[1,3,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[1,3,1,""],merge:[1,3,1,""],mergeMapping:[1,3,1,""],mergeSequence:[1,3,1,""],overwriteKeys:[1,3,1,""]},"src.pyconf.ConfigOutputStream":{close:[1,3,1,""],flush:[1,3,1,""],write:[1,3,1,""]},"src.pyconf.ConfigReader":{getChar:[1,3,1,""],getToken:[1,3,1,""],load:[1,3,1,""],location:[1,3,1,""],match:[1,3,1,""],parseFactor:[1,3,1,""],parseKeyValuePair:[1,3,1,""],parseMapping:[1,3,1,""],parseMappingBody:[1,3,1,""],parseReference:[1,3,1,""],parseScalar:[1,3,1,""],parseSequence:[1,3,1,""],parseSuffix:[1,3,1,""],parseTerm:[1,3,1,""],parseValue:[1,3,1,""],setStream:[1,3,1,""]},"src.pyconf.Container":{evaluate:[1,3,1,""],setPath:[1,3,1,""],writeToStream:[1,3,1,""],writeValue:[1,3,1,""]},"src.pyconf.Expression":{evaluate:[1,3,1,""]},"src.pyconf.Mapping":{addMapping:[1,3,1,""],get:[1,3,1,""],iteritems:[1,3,1,""],iterkeys:[1,3,1,""],keys:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Reference":{addElement:[1,3,1,""],findConfig:[1,3,1,""],resolve:[1,3,1,""]},"src.pyconf.Sequence":{SeqIter:[1,2,1,""],append:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Sequence.SeqIter":{next:[1,3,1,""]},"src.system":{archive_extract:[1,1,1,""],cvs_extract:[1,1,1,""],git_extract:[1,1,1,""],show_in_editor:[1,1,1,""],svn_extract:[1,1,1,""]},"src.template":{MyTemplate:[1,2,1,""],substitute:[1,1,1,""]},"src.template.MyTemplate":{delimiter:[1,5,1,""],pattern:[1,5,1,""]},"src.test_module":{Test:[1,2,1,""],getTmpDirDEFAULT:[1,1,1,""]},"src.test_module.Test":{generate_launching_commands:[1,3,1,""],generate_script:[1,3,1,""],get_test_timeout:[1,3,1,""],get_tmp_dir:[1,3,1,""],prepare_testbase:[1,3,1,""],prepare_testbase_from_dir:[1,3,1,""],prepare_testbase_from_git:[1,3,1,""],prepare_testbase_from_svn:[1,3,1,""],read_results:[1,3,1,""],run_all_tests:[1,3,1,""],run_grid_tests:[1,3,1,""],run_script:[1,3,1,""],run_session_tests:[1,3,1,""],run_testbase_tests:[1,3,1,""],run_tests:[1,3,1,""],search_known_errors:[1,3,1,""],write_test_margin:[1,3,1,""]},"src.xmlManager":{ReadXmlFile:[1,2,1,""],XmlLogFile:[1,2,1,""],add_simple_node:[1,1,1,""],append_node_attrib:[1,1,1,""],find_node_by_attrib:[1,1,1,""],write_report:[1,1,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[1,3,1,""],get_attrib:[1,3,1,""],get_node_text:[1,3,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[1,3,1,""],append_node_attrib:[1,3,1,""],append_node_text:[1,3,1,""],write_tree:[1,3,1,""]},src:{ElementTree:[1,0,0,"-"],Path:[1,2,1,""],SatException:[1,4,1,""],activate_mesa_property:[1,1,1,""],architecture:[1,0,0,"-"],check_config_has_application:[1,1,1,""],check_config_has_profile:[1,1,1,""],colorama:[2,0,0,"-"],compilation:[1,0,0,"-"],config_has_application:[1,1,1,""],debug:[1,0,0,"-"],deepcopy_list:[1,1,1,""],ensure_path_exists:[1,1,1,""],environment:[1,0,0,"-"],fileEnviron:[1,0,0,"-"],find_file_in_lpath:[1,1,1,""],fork:[1,0,0,"-"],get_base_path:[1,1,1,""],get_cfg_param:[1,1,1,""],get_launcher_name:[1,1,1,""],get_log_path:[1,1,1,""],get_property_in_product_cfg:[1,1,1,""],get_salome_version:[1,1,1,""],get_tmp_filename:[1,1,1,""],handleRemoveReadonly:[1,1,1,""],logger:[1,0,0,"-"],merge_dicts:[1,1,1,""],only_numbers:[1,1,1,""],options:[1,0,0,"-"],parse_date:[1,1,1,""],print_info:[1,1,1,""],printcolors:[1,0,0,"-"],product:[1,0,0,"-"],pyconf:[1,0,0,"-"],read_config_from_a_file:[1,1,1,""],remove_item_from_list:[1,1,1,""],replace_in_file:[1,1,1,""],system:[1,0,0,"-"],template:[1,0,0,"-"],test_module:[1,0,0,"-"],xmlManager:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:exception","5":"py:attribute"},terms:{"0x36fa5f0":[],"0x37b8f90":[],"0x37f8420":[],"0x44e4620":[],"0x4986ff0":[],"16be":1,"16le":1,"9abc":1,"boolean":[1,19],"case":1,"char":1,"class":[1,2,19],"default":[1,3,5,6,8,10,11,12,13,18,19],"export":13,"final":[1,6,13],"float":1,"function":[1,2,19],"import":[1,8,19],"int":[1,11],"long":[1,4],"new":[1,13,19],"return":[1,8,19],"short":1,"true":[1,2],"try":1,"var":[1,8,19],And:[1,6,8],But:19,CVS:12,For:[1,8,13,15,19],Has:1,One:1,POS:2,The:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,18,19],Then:[13,14],There:14,These:8,Theses:4,Use:[3,4,5,6,8,9,10,13],Used:1,Useful:18,VCS:[4,12],__init__:[],__save__:1,__setattr__:1,_appli:3,_blank:1,_build:8,_debug:1,_launch:8,_ld_library_path:8,_sre:[1,2],a_b_c_:1,abool:1,about:[1,14],absolut:12,access:[1,2,11],account:8,act:[1,2],action:1,activ:[1,13],activate_mesa_properti:1,actual:[1,2,16],add:[1,5,15],add_com:1,add_echo:1,add_lin:1,add_link:1,add_opt:[1,19],add_simple_nod:1,add_warn:1,added:1,addel:1,adding:19,addit:[1,5,14],additional_dir:1,additional_env:1,addmap:1,addnamespac:1,adequ:1,adot:1,advanc:1,affect:2,afil:1,after:[1,5,16],again:1,agent:13,aim:1,alevel:1,algorithm:19,all:[1,2,4,6,8,9,13,14,18,19],all_in_termin:1,allow:[1,5,6,9,15,18],alphanumer:1,alreadi:[12,19],also:[1,8,13,14,19],alter:13,amethodtodebug:1,amount:1,ani:[1,2,6,11,13],anoth:[1,14],ansi:[0,1],ansi_csi_r:2,ansi_escape_cod:2,ansi_osc_r:2,ansiback:2,ansicod:2,ansicursor:2,ansifor:2,ansistyl:2,ansitowin32:[0,1],apart:2,api:1,append:[1,8,12],append_node_attrib:1,append_node_text:1,append_valu:1,appli:[1,6,9,13],applic:[1,4,5,6,8,9,10,11,13,15,19],application_nam:3,appropri:1,arch:12,architectur:[0,12,14],archiv:[1,12,13],archive_extract:1,archive_info:13,arg:[1,2,19],arglist:1,argument:[1,19],ascii:[1,7],ask:1,assign:1,assum:1,astr:1,astream:1,atitl:1,attibut:1,attr:[1,2],attrib:1,attribut:[1,2],authent:13,author:1,automat:[6,8],autoreset:2,autotool:[1,5],avail:6,avari:1,avoid:13,award:1,back:2,backtick:1,base:[1,2,14],bash:[1,8,13],bashfileenviron:1,bat:[1,8],batch:1,batch_salom:1,batfileenviron:1,becaus:1,been:[1,2],befor:[1,5],begin:1,behavior:19,being:1,belong:1,below:8,between:[1,19],bienvenu:1,big:5,bigger:1,bin:8,binari:12,black:2,blogmatrix:1,blue:2,bom:1,bonjour:19,bool:1,both:[1,8,9],bracket:1,branch:13,bright:2,bright_background:2,bring:[9,13],browser:[1,6,7,11,14],buf:1,build:[1,4,5,8,14],build_conf_opt:1,build_configur:1,build_sourc:5,builder:1,built:1,call:[1,2,8,10,19],call_win32:2,callabl:1,can:[1,3,8,13,14,15,19],cannot:1,car:1,care:4,carri:1,catalog:[3,10],cfg:[1,8,19],cfg_env:1,cfgforpi:1,chang:[1,3,18,19],change_to_launch:1,charact:[1,2],charg:10,check:[1,5,8],check_config_exist:1,check_config_has_appl:1,check_config_has_profil:1,check_instal:1,check_sourc:1,check_src:1,checkout:[1,13],chmod:1,choic:6,circumst:1,clash:1,classic:1,clean:[1,5,11,15],clean_al:[5,18],clean_build_aft:5,clean_instal:5,cleancolor:1,clear_lin:2,clear_screen:2,cli:[11,18],cli_:19,client:1,clone:13,close:1,closest:1,cmake:[1,5],cmake_opt:5,cmd:1,co7:12,code:[1,2,8],code_to_char:2,color:[1,2],colorama:[0,1],colorama_text:2,column:1,com:1,come:6,command:[1,2,14,16,18],command_nam:1,command_opt:18,command_r:1,command_valu:1,comment:[1,14],commentari:1,commit:4,common:1,commonli:1,compat:1,compil:[0,7,8,9,11,13,15],compil_script:5,complementari:8,complet:[5,6,13,14],complete_environ:1,compon:[1,3,9],componon:9,compress:12,comput:[1,9,12],concaten:1,concern:13,config:[1,13,14,15,18],config_has_appl:1,configerror:1,configformaterror:1,configinputstream:1,configlist:1,configmerg:1,configoutputstream:1,configread:1,configresolutionerror:1,configur:[1,15,19],configure_opt:1,configut:3,conflict:1,conform:9,consist:1,consol:1,construct:[1,15,17],contain:[1,14,19],content:0,context:[1,18],contextfileenviron:1,continu:1,control:12,conveni:1,convert:2,convert_ansi:2,convert_osc:2,copi:[1,3,6,10,18],copydir:1,copyfil:1,copylink:1,copyright:1,corba:9,correct:1,correl:1,correspond:[1,8,11,13],could:[1,4,8,16],cpp:[1,9],creat:[1,3,4,8,10,12,13,14,15],creation:12,current:[1,6,14,18,19],cursor_adjust:2,cvs:1,cvs_extract:1,cvs_info:13,cvspass:13,cwd:1,cyan:2,dai:1,data:[1,6,19],date:[1,14],date_to_datetim:1,datetim:1,david:1,dbg:1,debug:[0,6,8,13],debug_writ:1,decid:1,declar:13,deep:1,deepcopy_list:1,deepcopymap:1,def:[1,8,19],default_valu:1,defaultmergeresolv:1,defaultstreamopen:1,defin:[1,4,5,6,8,9,14,19],definit:1,deinit:2,delai:1,delaiapp:1,deleg:2,delet:12,delimit:1,delta:1,depend:[1,5,12],deriv:1,describ:1,descript:[1,19],design:1,destnam:1,detail:1,detar:16,detect:1,determin:1,dev:1,develop:[1,4,6,8,13,19],dict:1,dict_arg:1,dictionari:[1,14],differ:8,dim:2,dir:[1,6,13],dir_info:13,directli:[8,11,16],directori:[1,3,4,5,6,8,10,11,12,13,14,16,18,19],dirpath:1,displai:[1,5,6,7,11,19],distant:3,distinguish:8,distrib:1,distribut:[1,3,9],divis:1,dixt:1,do_batch_script_build:1,do_default_build:1,do_python_script_build:1,do_script_build:1,doc:15,doctyp:1,document:[7,9,14,19],doe:[1,8,13],dollar:1,don:9,done:[8,18],dot:1,dove:1,down:2,download:[1,13],drive:1,dst:1,due:1,dump:1,duplic:5,dure:13,dynam:14,each:[1,3,10,13,14],earlier:1,earliest:1,echo:1,edit:[6,7,13],editor:[1,6,7,14],eearch:1,either:[1,8],eleg:1,elem:1,element:1,element_factori:1,elementtre:0,els:[1,19],embed:12,empti:1,enable_simple_env_script:1,enclos:1,encod:1,end:[1,2,8],end_writ:1,ensur:1,ensure_path_exist:1,entri:1,env:8,env_build:8,env_info:1,env_launch:8,env_script:8,environ:[0,9,14,15],equal:5,eras:11,erase_lin:2,erase_screen:2,error:1,etc:[1,14,15],etre:1,eval:1,evalu:1,event:1,everyth:5,evinc:7,exactli:1,exampl:[1,4,5,6,7,8,12,13,15,18],exc:1,except:[1,13,18],execut:[1,5,13,18],exhaust:[14,18],exist:[1,12,13,18],exot:1,expect:1,explain:8,explicitli:1,explor:6,express:[1,6],extens:[1,19],extra:1,extract:1,extract_param:2,fact:19,factor:1,factori:1,fail:[1,5],fals:[1,2],far:1,favorit:6,feed:1,field:1,file:[1,3,5,6,7,8,10,11,12,13,14,15,19],file_nam:1,file_path:1,fileenviron:0,fileenvwrit:1,filein:1,filenam:1,filepath:1,filter:[1,4],filterlevel:1,filterlist2:1,fin:1,find:[1,6,15,16],find_file_in_lpath:1,find_node_by_attrib:1,findal:1,findconfig:1,findtext:1,finish:1,firefox:[7,11,14],first:[1,8,13,19],fix:1,flag:5,flush:1,fmt:1,follow:[1,8,19],for_packag:1,forbuild:1,forc:[1,12,13],force_patch:13,fore:2,forget:1,fork:0,form:1,format:[1,7,8,14],forward:[2,3,10],found:1,four:8,french:19,from:[1,2,6,7,8,9,12,13,19],from_what:1,fromstr:1,full:1,full_launched_command:1,fun:6,func:1,futur:1,gdb:8,gedit:7,gencat:[3,10],gener:[1,2,3,8,10,15,18],generate_launching_command:1,generate_script:1,generic_opt:18,geom:5,get:[1,6,7,13,14,19],get_attr:2,get_attrib:1,get_base_install_dir:1,get_base_path:1,get_cfg_param:1,get_distrib_vers:1,get_distribut:1,get_file_environ:1,get_help:1,get_install_dir:1,get_launcher_nam:1,get_log_path:1,get_method:13,get_nam:1,get_nb_proc:1,get_node_text:1,get_posit:2,get_product_compon:1,get_product_config:1,get_product_depend:1,get_product_sect:1,get_products_info:1,get_property_in_product_cfg:1,get_python_vers:1,get_salome_vers:1,get_test_timeout:1,get_tmp_dir:1,get_tmp_filenam:1,get_us:1,get_win32_cal:2,getbypath:1,getchar:1,getdetailopt:1,getiter:1,getlocalenv:1,getroot:1,getrootattrib:1,getstrconfigdbg:1,getstrconfigstd:1,gettmpdir:1,gettmpdirdefault:1,gettoken:1,git:[1,12],git_extract:1,git_info:13,gitconfig:13,give:[1,3,14,19],given:[1,2,3,8,10],global:1,goe:1,green:2,grei:2,grep:6,grid:1,gui:1,hack_libtool:1,had:1,handl:[1,2,8],handlemismatch:1,handleremovereadonli:1,hard:1,harri:1,has:[1,2,8,19],has_salome_hui:1,has_timed_out:1,hat:1,have:[1,3,4,9,10,13],header:1,help:[1,19],helpstr:1,here:[1,8,14,19],hierarchi:1,highlight:1,himself:8,hold:10,home:6,hour:1,how:[1,7,8,13,14],html:[1,7],http:[1,2],hxx2salom:9,ident:1,identifi:1,ignor:[1,9],ignorelist:1,imag:13,implement:[1,2,8],includ:[1,8,12,14],indent:1,index:1,indic:1,indirect:1,info:[1,6,13],inform:[1,6,7,12,13,14],init:[1,2],initi:1,initialis:[0,1],inmap:1,input:1,input_list:1,insid:13,instal:[1,4,5,14,15,18],install_dir:8,instanc:[1,2,19],instanti:1,instead:1,instream:1,instruct:[1,14],intal:12,interact:11,interfac:[1,18],intern:1,invalid:1,ioerror:1,iostream:1,is_a_tti:2,is_defin:1,is_salome_modul:[4,8],is_stream_clos:2,is_window:1,isdir:1,isel:1,isfil:1,islink:1,issu:2,isword:1,item:1,iter:1,iteritem:1,iterkei:1,iterpars:1,its:[1,5,6,8,14],ivar:1,jane:1,job:5,join:8,just:[1,5],keep:1,kei:[1,8,13],kernel:[1,6,18],killsalom:1,know:[1,13],known:12,kwarg:2,kwd:2,label:[1,6],lanch:1,lapack:8,lapack_root_dir:8,last:[1,8,11],last_termin:11,later:12,latter:1,launch:[1,8],launch_command:1,launcher:[1,3,8,15],launcher_nam:10,launcherfileenviron:1,layer:9,ld_library_path:8,left:8,level:[1,18,19],lhs:1,lib:8,librari:1,light:2,lightblack_ex:2,lightblue_ex:2,lightcyan_ex:2,lightgreen_ex:2,lightmagenta_ex:2,lightred_ex:2,lightwhite_ex:2,lightyellow_ex:2,like:[1,2,3,5,6,10,14],line:[1,6,18],link:[1,13],list:[1,3,4,6,10,14],list_log_fil:1,list_of_product:9,listtest:1,llvm:[3,10],load:[1,14],load_cfg_environ:1,load_environ:1,local:[6,7],locat:1,log:[1,5,15,19],log_command:1,log_dir:11,log_file_nam:1,logdir:1,logfilepath:1,logger:0,login:13,logo:[1,10],lome:15,longnam:1,lost:1,lpath:1,lproduct:1,machin:[1,3,9,10,12],machine1:3,machine2:3,machine3:3,magenta:2,mai:13,main:5,make:[1,5],make_flag:5,make_opt:1,makepath:1,manag:[1,6,13],manipul:[1,6],map1:1,map2:1,map:1,match:1,max:1,mechan:[1,8],med:5,memori:[3,10],menu:11,merg:1,merge:1,merge_dict:1,mergemap:1,mergesequ:1,mesa:[1,3,10],messag:[1,19],method:[1,2,5,8,13,19],micro_command:1,minim:1,minut:1,mismatch:1,miss:[3,5],mistak:13,mode:[1,2,4,6,8,11,18],model:19,modifi:[1,7,8,13],modul:[0,3,5,9,10,13,14,15],mon:1,mond:19,more:[1,18],most:[1,8,19],multi:1,multilin:1,multipl:1,must:[1,19],my_application_directori:3,my_application_nam:3,my_tag:13,mycommand:19,mydebug:1,myoption:19,myspecificnam:12,mytempl:1,name:[1,3,4,6,8,10,12,13,14,18,19],name_nod:1,namespac:1,nativ:[1,8],nb_line:1,nb_proc:[1,5],need:[1,2,3,9,13],new_nam:6,next:1,nfirst:1,no_label:6,node:1,node_nam:1,non:2,none:[1,2],nor:2,normal:[1,2],note:[1,3,8,10,14],noth:[1,12],notimplementederror:1,notion:1,notshowncommand:1,number:[1,3,5,10,11],number_of_proc:1,obj1:1,obj2:1,object:[1,2,14],obtain:1,obvious:1,occur:1,ode:1,old:1,older:11,on_stderr:2,onc:13,one:[1,6],onli:[1,3,4,5,6,8,9,10,11,13,18],only_numb:1,ool:15,open:1,openggl:[3,10],openmpi:1,oper:[1,6,15],operand:1,opt_nb_proc:1,option:[0,2,3,5,6,8,9,10,11,12,13,14,19],optionali:1,optiontyp:1,optresult:1,order:[1,13,14,19],org:2,other:[1,8,12,14],otherwis:[1,13],our:2,out:1,out_dir:1,output:[1,2],output_verbose_level:1,outstream:1,overrid:[1,3],overwrit:1,overwritekei:1,overwritemergeresolv:1,overwritten:1,own:1,packag:[0,15,16],page:8,pair:1,param:[1,2],param_nam:1,paramet:[1,6,14,19],parameter_path:6,paramstr:2,paravi:[3,10],parent:1,parma:1,pars:[1,19],parse_arg:[1,19],parse_d:1,parseargu:1,parsefactor:1,parsekeyvaluepair:1,parsemap:1,parsemappingbodi:1,parser:[1,19],parserefer:1,parsescalar:1,parsesequ:1,parsesuffix:1,parseterm:1,parsevalu:1,part:[1,3,8,10],particular:1,pass:[1,14,19],passphras:13,password:13,patch:[1,6,13],path:[1,8,10],path_to_catalog:3,path_to_yacsgen:9,pattern:1,pdf:[6,7,15],pdf_viewer:7,pend:4,pendant:1,perform:[13,15],person:6,phase:1,platform:[2,8],pleas:[8,9],plugin:[1,5],pluma:[7,14],point:[1,19],pop_debug:1,popul:1,posit:2,possibl:[1,8,13,19],potenti:1,pprty:1,preced:1,prefer:[6,7,14],prefix:[1,8,14],prepar:[1,15,19],prepare_testbas:1,prepare_testbase_from_dir:1,prepare_testbase_from_git:1,prepare_testbase_from_svn:1,prepend:[1,8],prepend_valu:1,prereq_dir:8,prerequisit:[8,12,14,15,18],presenc:1,preset:1,pretti:1,previou:1,previous:4,print:[1,2,6,11],print_color_map:1,print_color_rang:1,print_help:1,print_info:1,print_valu:1,printc:1,printcerror:1,printchead:1,printchighlight:1,printcinfo:1,printclabel:1,printcolor:0,printcsuccess:1,printcwarn:1,problem:[1,3,10],procedur:1,process:13,processinginstruct:1,processor:[1,3,10],prod_dir:1,prod_info:1,produc:1,product1:[5,8,13],product2:[5,8,13],product:[0,4,5,6,8,9,10,12,13,15,19],product_cfg:1,product_compil:1,product_has_env_script:1,product_has_logo:1,product_has_patch:1,product_has_salome_gui:1,product_has_script:1,product_info:1,product_is_autotool:1,product_is_cmak:1,product_is_cpp:1,product_is_debug:1,product_is_dev:1,product_is_fix:1,product_is_gener:1,product_is_mpi:1,product_is_n:1,product_is_salom:1,product_is_sampl:[],product_is_smesh_plugin:1,product_is_vc:1,product_is_verbos:1,product_nam:1,profil:[1,10],program:1,programmat:8,progress:1,project:[6,8],properti:[1,4,8,9],protocol:[1,3],provid:[1,8,19],proxi:2,pubid:1,push:13,push_debug:1,put:1,put_initial_xml_field:1,put_txt_log_in_appli_log_dir:1,pv_plugin_path:1,pwd:1,pyconf:[0,5,6,8,13,14,19],python:[1,8,10,14,15,16,19],python_config:1,pythonpath:8,pythonpath_:8,qname:1,queri:[3,10],rais:[1,18],rang:1,raw:1,read:1,read_config_from_a_fil:1,read_result:1,reader:1,readi:13,readlin:1,readlink:1,readxmlfil:1,recurs:[1,6],red:[1,2],redefin:1,redirect:1,ref:1,refer:[1,9,14],reflect:1,regard:1,regular:1,reinit:[1,2],rel:[1,12],remain:[11,16],remainderarg:1,remark:3,remor:9,remot:[1,12],remov:[1,4,5,13],remove_item_from_list:1,removenamespac:1,renam:1,renint:1,replac:[1,3],replace_in_fil:1,report:1,repositori:[1,13],repres:1,represent:1,request:2,requir:[1,2,8,9],reserv:1,reset:2,reset_al:2,resolut:1,resolv:1,resourc:[3,10],respect:8,restor:[1,4],result:1,retriev:1,rhs:1,right:[1,8],root:[1,19],root_nod:1,rootnam:1,rst:7,rtype:1,run:[1,8,14,15,19],run_all_test:1,run_env_script:1,run_grid_test:1,run_script:1,run_session_test:1,run_simple_env_script:1,run_test:1,run_testbase_test:1,runappli:3,runner:19,ruud:1,sajip:1,salom:[1,3,4,5,6,8,9,10,12,14,16],salome_modul:1,salome_session_serv:1,salome_xx:[4,12,16,18],salome_xx_:12,salomecontext:1,salomeenviron:1,salometool:[1,3,6,8,12,14,15,16],same:[1,7],sampl:18,sat:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,19],satexcept:1,save:8,saveconfigdbg:1,saveconfigstd:1,scalar:1,screenenviron:1,screenonli:1,script:[1,5,6,8,10,14,15,16],script_nam:1,script_path:1,search:1,search_known_error:1,second:[1,8,19],section:[1,3,8,13],secur:13,see:[1,2,14,18],seen:1,select:12,self:1,semant:1,sep:[1,8],separ:1,seq1:1,seq2:1,seq:1,seqit:1,sequenc:[1,2],server:[1,13],servic:19,session:1,set:[1,3,4,8,10,14,15,19],set_a_product:1,set_application_env:1,set_attr:2,set_consol:2,set_cpp_env:1,set_cursor_posit:2,set_env:[1,8],set_env_build:8,set_env_launch:8,set_full_environ:1,set_native_env:[1,8],set_product:1,set_python_libdir:1,set_salome_generic_product_env:1,set_salome_minimal_product_env:1,set_titl:2,setconsoletextattribut:2,setpath:1,setstream:1,sever:[8,14],shallow:1,shell:[1,8],shortcut:1,shortnam:1,should:[1,8,9],should_wrap:2,show:[1,5,7,11],show_command_log:1,show_desktop:1,show_in_editor:1,show_patch:6,show_progress:1,show_warn:1,showinfo:1,shown:[1,5],sign:1,silent_sysstd:1,similar:1,simpl:[1,18,19],sinc:1,site:1,size:1,smaller:1,smart:1,smartcopi:1,smesh:1,softwar:13,some:[1,8,10,14,19],someon:8,sometim:4,sommeil:1,soon:5,sourc:[1,2,4,6,7,12,13],sources_without_dev:4,special_path_separ:1,specif:[1,3,4,8,9,10,12,14,18],specifi:[1,3,8,9,10,13],splashscreen:10,src:19,src_root:1,sre_pattern:[1,2],ssh:[3,10,13],stack:18,start:[1,2,3,5,10],statu:1,stderr:1,stdout:[1,2],step:1,stop:5,stop_first_fail:5,store:[1,5,6,11,13,14],str:1,str_num:1,stream:[1,2],streamopen:1,streamorfil:1,streamwrapp:2,strin:1,string:1,stringio:1,strip:2,strout:1,structur:14,stuff:[1,10],style:[1,2],stylesheet:1,sub:[1,14],subclass:1,subel:1,submodul:0,subpackag:0,subsect:8,subset:12,subst_dic:1,substitut:1,subtract:1,success:[1,5],successfulli:1,suffici:8,suffix:1,suit:15,suitabl:1,support:1,supposedli:1,suppress:4,svn:[1,12],svn_extract:1,svn_info:13,symlink:1,syntax:[1,4],sys:1,system:[0,12],tab:1,tabl:1,tag:[1,13],take:[1,4],taken:[1,8],tar:[12,16],target:[1,3,8],tcllibpath:1,templat:0,template_fil:1,temporari:1,term:1,termin:[1,2,5,11,19],test:[1,5,15],test_base_nam:1,test_config:1,test_grid:1,test_modul:0,test_nam:1,test_sess:1,testbas:1,testbase_bas:1,testbase_dir:1,testbase_nam:1,testbase_tag:1,text:[1,2,7,18],text_or_uri:1,tgz:[12,16],thank:1,thei:[4,6,8,13],them:[2,13],thi:[1,2,3,5,6,8,9,10,12,13,14,15,19],thing:19,those:9,through:[3,8,10,11],thrown:1,time:[1,4,8,13,14],timedelta:1,timedelta_total_second:1,titl:[1,2],tklibpath:1,tmp_working_dir:1,tofix:1,token:1,token_typ:1,token_valu:1,top:1,tostr:1,total_second:1,tout:19,trace:18,transform:1,transpar:2,tree:1,treebuild:1,trust_root_dir:8,tty:2,tupl:1,turn:1,tutori:1,two:[1,8],txt:1,type:[1,13],typeerror:1,unabl:1,unchang:1,unconditionali:[1,18],under:[1,15],underscor:[1,8],unicod:1,unit:5,unless:[2,13],updat:1,update_hat_xml:1,updatehatxml:1,urllib2:1,urlopen:1,usag:[1,15],use:[1,3,5,8,10,11,12,13,14,16],use_mesa:[3,10],used:[1,3,5,6,7,8,11,12,13,14,15],useful:[8,10,19],user:[1,6,7,8,11,12,16,18],usernam:1,uses:[1,8,9,13,14],using:[1,2,9],usr:8,usual:[4,9,12,14,16,18],utf:[1,8],util:[1,12,15],valid:1,valu:[1,2,3,4,6,13,14],variabl:[1,8,9,19],vcs:1,verbos:[1,19],verifi:[1,13],version:[1,8,9,12,14,15],via:1,viewer:[6,7],vinai:1,virtual:[1,3],virtual_app:3,visualis:8,wai:[1,5,19],want:[1,4,8,19],warn:[1,5],web:[6,7,11,14],welcom:1,welkom:1,well:1,were:1,what:[1,4],when:[1,3,8,13,14,19],whenev:1,where:[1,3,5,6,12],which:[1,2,8,9,14,19],white:2,who:9,wiki:2,wikipedia:2,wil:8,win32:[0,1],winapi_test:2,wincolor:2,window:[1,2,8],winstyl:2,winterm:[0,1],with_children:5,with_commerci:1,with_fath:5,with_install_dir:1,with_vc:12,within:8,without:[1,6,13],without_properti:12,wmake:1,word:1,work:[1,6,12,13,14],workdir:[1,3,6,10,12,14,18,19],world:19,would:1,wrap:2,wrap_stream:2,writabl:1,write:[1,2,19],write_and_convert:2,write_back:1,write_cfgforpy_fil:1,write_env_fil:1,write_plain_text:2,write_report:1,write_test_margin:1,write_tre:1,writetostream:1,writevalu:1,written:19,www:1,xa4:1,xc2:1,xml:[1,19],xmllogfil:1,xmlmanag:0,xmlroot:1,xmltreebuild:1,xxx:[4,14],xxx_root_dir:1,xxx_src_dir:1,yac:1,yacsgen:[1,9],yacsgen_root_dir:9,year:1,yellow:2,yes:[1,4,8,9,13],yet:18,yield:1,you:[1,3,4,8,10,13,15,19],your:[1,7,8,13,18,19],yourspecificnam:12,yve:1,yyi:14,yyyi:1,yyyymmdd_hhmmss:1,yyyymmdd_hhmmss_namecmd:1,zelaunch:10,zero:1,zerodivideerror:1},titles:["src","src package","src.colorama package","Command application","Command clean","Command compile","Command config","Command doc","Command environ","Command generate","Command launcher","Command log","Command package","Command prepare","Configuration","Salome Tools","Installation","Release notes","Usage of SAlomeTools","Add a user custom command"],titleterms:{"var":14,VCS:13,access:19,add:19,ansi:2,ansitowin32:2,applic:[3,14],architectur:1,avail:[4,18],base:13,basic:19,build:18,clean:4,code:15,colorama:2,command:[3,4,5,6,7,8,9,10,11,12,13,15,19],compil:[1,5,18],config:[6,19],configur:[3,4,5,6,7,8,10,11,12,13,14],content:[1,2],custom:19,cvs:13,debug:[1,18],descript:[3,4,5,6,7,8,9,10,11,12,13,14],dev:13,develop:15,doc:7,document:15,elementtre:1,environ:[1,8],exampl:19,fileenviron:1,fork:1,gener:9,get:18,git:13,hello:19,help:18,howto:19,initialis:2,instal:16,introduct:19,launcher:10,list:[15,18],log:11,logger:[1,19],mode:13,modul:[1,2],note:[15,17],option:[1,4,18],other:19,packag:[1,2,12],path:[3,4,5,6,7,11,12,13],prepar:[13,18],printcolor:1,product:[1,14,18],pyconf:1,quick:15,releas:[15,17],remark:[9,13],requir:19,salom:[15,18],salometool:[18,19],sat:18,section:14,some:[3,4,5,6,7,11,12,13],sourc:18,src:[0,1,2],start:15,submodul:[1,2],subpackag:1,svn:13,syntax:14,system:1,templat:1,test_modul:1,tool:15,usag:[3,4,5,6,7,8,9,10,11,12,13,18],useful:[3,4,5,6,7,11,12,13],user:[14,19],verbos:18,win32:2,winterm:2,xmlmanag:1}})
\ No newline at end of file
\@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}{8}{section.2.1}}
-\newlabel{commands/config:svn}{{2.1}{8}{Command config}{section.2.1}{}}
-\newlabel{commands/config:command-config}{{2.1}{8}{Command config}{section.2.1}{}}
-\newlabel{commands/config::doc}{{2.1}{8}{Command config}{section.2.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.1}Command doc}{8}{section.2.1}}
+\newlabel{commands/doc:svn}{{2.1}{8}{Command doc}{section.2.1}{}}
+\newlabel{commands/doc::doc}{{2.1}{8}{Command doc}{section.2.1}{}}
+\newlabel{commands/doc:command-doc}{{2.1}{8}{Command doc}{section.2.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}}
-\newlabel{commands/config:description}{{2.1.1}{8}{Description}{subsection.2.1.1}{}}
+\newlabel{commands/doc:description}{{2.1.1}{8}{Description}{subsection.2.1.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2}}
-\newlabel{commands/config:usage}{{2.1.2}{8}{Usage}{subsection.2.1.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3}}
-\newlabel{commands/config:some-useful-configuration-pathes}{{2.1.3}{9}{Some useful configuration pathes}{subsection.2.1.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2}}
-\newlabel{commands/prepare:svn}{{2.2}{10}{Command prepare}{section.2.2}{}}
-\newlabel{commands/prepare:command-prepare}{{2.2}{10}{Command prepare}{section.2.2}{}}
-\newlabel{commands/prepare::doc}{{2.2}{10}{Command prepare}{section.2.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1}}
-\newlabel{commands/prepare:description}{{2.2.1}{10}{Description}{subsection.2.2.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2}}
-\newlabel{commands/prepare:remarks}{{2.2.2}{10}{Remarks}{subsection.2.2.2}{}}
-\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14}}
-\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.2.2}{10}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15}}
-\newlabel{commands/prepare:dev-mode}{{2.2.2}{10}{Dev mode}{subsubsection*.15}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3}}
-\newlabel{commands/prepare:usage}{{2.2.3}{10}{Usage}{subsection.2.2.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4}}
-\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.2.4}{11}{Some useful configuration pathes}{subsection.2.2.4}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3}}
-\newlabel{commands/compile:svn}{{2.3}{12}{Command compile}{section.2.3}{}}
-\newlabel{commands/compile:command-compile}{{2.3}{12}{Command compile}{section.2.3}{}}
-\newlabel{commands/compile::doc}{{2.3}{12}{Command compile}{section.2.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1}}
-\newlabel{commands/compile:description}{{2.3.1}{12}{Description}{subsection.2.3.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2}}
-\newlabel{commands/compile:usage}{{2.3.2}{12}{Usage}{subsection.2.3.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3}}
-\newlabel{commands/compile:some-useful-configuration-pathes}{{2.3.3}{13}{Some useful configuration pathes}{subsection.2.3.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4}}
-\newlabel{commands/launcher:svn}{{2.4}{14}{Command launcher}{section.2.4}{}}
-\newlabel{commands/launcher:command-launcher}{{2.4}{14}{Command launcher}{section.2.4}{}}
-\newlabel{commands/launcher::doc}{{2.4}{14}{Command launcher}{section.2.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1}}
-\newlabel{commands/launcher:description}{{2.4.1}{14}{Description}{subsection.2.4.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2}}
-\newlabel{commands/launcher:usage}{{2.4.2}{14}{Usage}{subsection.2.4.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3}}
-\newlabel{commands/launcher:configuration}{{2.4.3}{14}{Configuration}{subsection.2.4.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5}}
-\newlabel{commands/application:svn}{{2.5}{15}{Command application}{section.2.5}{}}
-\newlabel{commands/application::doc}{{2.5}{15}{Command application}{section.2.5}{}}
-\newlabel{commands/application:command-application}{{2.5}{15}{Command application}{section.2.5}{}}
+\newlabel{commands/doc:usage}{{2.1.2}{8}{Usage}{subsection.2.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}}
+\newlabel{commands/doc:some-useful-configuration-pathes}{{2.1.3}{8}{Some useful configuration pathes}{subsection.2.1.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command config}{9}{section.2.2}}
+\newlabel{commands/config:svn}{{2.2}{9}{Command config}{section.2.2}{}}
+\newlabel{commands/config:command-config}{{2.2}{9}{Command config}{section.2.2}{}}
+\newlabel{commands/config::doc}{{2.2}{9}{Command config}{section.2.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{9}{subsection.2.2.1}}
+\newlabel{commands/config:description}{{2.2.1}{9}{Description}{subsection.2.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Usage}{9}{subsection.2.2.2}}
+\newlabel{commands/config:usage}{{2.2.2}{9}{Usage}{subsection.2.2.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Some useful configuration pathes}{10}{subsection.2.2.3}}
+\newlabel{commands/config:some-useful-configuration-pathes}{{2.2.3}{10}{Some useful configuration pathes}{subsection.2.2.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command prepare}{11}{section.2.3}}
+\newlabel{commands/prepare:svn}{{2.3}{11}{Command prepare}{section.2.3}{}}
+\newlabel{commands/prepare:command-prepare}{{2.3}{11}{Command prepare}{section.2.3}{}}
+\newlabel{commands/prepare::doc}{{2.3}{11}{Command prepare}{section.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{11}{subsection.2.3.1}}
+\newlabel{commands/prepare:description}{{2.3.1}{11}{Description}{subsection.2.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Remarks}{11}{subsection.2.3.2}}
+\newlabel{commands/prepare:remarks}{{2.3.2}{11}{Remarks}{subsection.2.3.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{11}{subsubsection*.14}}
+\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.3.2}{11}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{11}{subsubsection*.15}}
+\newlabel{commands/prepare:dev-mode}{{2.3.2}{11}{Dev mode}{subsubsection*.15}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Usage}{11}{subsection.2.3.3}}
+\newlabel{commands/prepare:usage}{{2.3.3}{11}{Usage}{subsection.2.3.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.4}Some useful configuration pathes}{12}{subsection.2.3.4}}
+\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.3.4}{12}{Some useful configuration pathes}{subsection.2.3.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command compile}{13}{section.2.4}}
+\newlabel{commands/compile:svn}{{2.4}{13}{Command compile}{section.2.4}{}}
+\newlabel{commands/compile:command-compile}{{2.4}{13}{Command compile}{section.2.4}{}}
+\newlabel{commands/compile::doc}{{2.4}{13}{Command compile}{section.2.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{13}{subsection.2.4.1}}
+\newlabel{commands/compile:description}{{2.4.1}{13}{Description}{subsection.2.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{13}{subsection.2.4.2}}
+\newlabel{commands/compile:usage}{{2.4.2}{13}{Usage}{subsection.2.4.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Some useful configuration pathes}{14}{subsection.2.4.3}}
+\newlabel{commands/compile:some-useful-configuration-pathes}{{2.4.3}{14}{Some useful configuration pathes}{subsection.2.4.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command launcher}{15}{section.2.5}}
+\newlabel{commands/launcher:svn}{{2.5}{15}{Command launcher}{section.2.5}{}}
+\newlabel{commands/launcher:command-launcher}{{2.5}{15}{Command launcher}{section.2.5}{}}
+\newlabel{commands/launcher::doc}{{2.5}{15}{Command launcher}{section.2.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1}}
-\newlabel{commands/application:description}{{2.5.1}{15}{Description}{subsection.2.5.1}{}}
+\newlabel{commands/launcher:description}{{2.5.1}{15}{Description}{subsection.2.5.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2}}
-\newlabel{commands/application:usage}{{2.5.2}{15}{Usage}{subsection.2.5.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3}}
-\newlabel{commands/application:some-useful-configuration-pathes}{{2.5.3}{15}{Some useful configuration pathes}{subsection.2.5.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6}}
-\newlabel{commands/log:svn}{{2.6}{16}{Command log}{section.2.6}{}}
-\newlabel{commands/log:command-log}{{2.6}{16}{Command log}{section.2.6}{}}
-\newlabel{commands/log::doc}{{2.6}{16}{Command log}{section.2.6}{}}
+\newlabel{commands/launcher:usage}{{2.5.2}{15}{Usage}{subsection.2.5.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Configuration}{15}{subsection.2.5.3}}
+\newlabel{commands/launcher:configuration}{{2.5.3}{15}{Configuration}{subsection.2.5.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command application}{16}{section.2.6}}
+\newlabel{commands/application:svn}{{2.6}{16}{Command application}{section.2.6}{}}
+\newlabel{commands/application::doc}{{2.6}{16}{Command application}{section.2.6}{}}
+\newlabel{commands/application:command-application}{{2.6}{16}{Command application}{section.2.6}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1}}
-\newlabel{commands/log:description}{{2.6.1}{16}{Description}{subsection.2.6.1}{}}
+\newlabel{commands/application:description}{{2.6.1}{16}{Description}{subsection.2.6.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2}}
-\newlabel{commands/log:usage}{{2.6.2}{16}{Usage}{subsection.2.6.2}{}}
+\newlabel{commands/application:usage}{{2.6.2}{16}{Usage}{subsection.2.6.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3}}
-\newlabel{commands/log:some-useful-configuration-pathes}{{2.6.3}{16}{Some useful configuration pathes}{subsection.2.6.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7}}
-\newlabel{commands/environ:svn}{{2.7}{17}{Command environ}{section.2.7}{}}
-\newlabel{commands/environ:command-environ}{{2.7}{17}{Command environ}{section.2.7}{}}
-\newlabel{commands/environ::doc}{{2.7}{17}{Command environ}{section.2.7}{}}
+\newlabel{commands/application:some-useful-configuration-pathes}{{2.6.3}{16}{Some useful configuration pathes}{subsection.2.6.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command log}{17}{section.2.7}}
+\newlabel{commands/log:svn}{{2.7}{17}{Command log}{section.2.7}{}}
+\newlabel{commands/log:command-log}{{2.7}{17}{Command log}{section.2.7}{}}
+\newlabel{commands/log::doc}{{2.7}{17}{Command log}{section.2.7}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1}}
-\newlabel{commands/environ:description}{{2.7.1}{17}{Description}{subsection.2.7.1}{}}
+\newlabel{commands/log:description}{{2.7.1}{17}{Description}{subsection.2.7.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2}}
-\newlabel{commands/environ:usage}{{2.7.2}{17}{Usage}{subsection.2.7.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3}}
-\newlabel{commands/environ:configuration}{{2.7.3}{17}{Configuration}{subsection.2.7.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8}}
-\newlabel{commands/clean:svn}{{2.8}{20}{Command clean}{section.2.8}{}}
-\newlabel{commands/clean:command-clean}{{2.8}{20}{Command clean}{section.2.8}{}}
-\newlabel{commands/clean::doc}{{2.8}{20}{Command clean}{section.2.8}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1}}
-\newlabel{commands/clean:description}{{2.8.1}{20}{Description}{subsection.2.8.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2}}
-\newlabel{commands/clean:usage}{{2.8.2}{20}{Usage}{subsection.2.8.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3}}
-\newlabel{commands/clean:availables-options}{{2.8.3}{20}{Availables options}{subsection.2.8.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4}}
-\newlabel{commands/clean:some-useful-configuration-pathes}{{2.8.4}{20}{Some useful configuration pathes}{subsection.2.8.4}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9}}
-\newlabel{commands/package:svn}{{2.9}{21}{Command package}{section.2.9}{}}
-\newlabel{commands/package:command-package}{{2.9}{21}{Command package}{section.2.9}{}}
-\newlabel{commands/package::doc}{{2.9}{21}{Command package}{section.2.9}{}}
+\newlabel{commands/log:usage}{{2.7.2}{17}{Usage}{subsection.2.7.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Some useful configuration pathes}{17}{subsection.2.7.3}}
+\newlabel{commands/log:some-useful-configuration-pathes}{{2.7.3}{17}{Some useful configuration pathes}{subsection.2.7.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command environ}{18}{section.2.8}}
+\newlabel{commands/environ:svn}{{2.8}{18}{Command environ}{section.2.8}{}}
+\newlabel{commands/environ:command-environ}{{2.8}{18}{Command environ}{section.2.8}{}}
+\newlabel{commands/environ::doc}{{2.8}{18}{Command environ}{section.2.8}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{18}{subsection.2.8.1}}
+\newlabel{commands/environ:description}{{2.8.1}{18}{Description}{subsection.2.8.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{18}{subsection.2.8.2}}
+\newlabel{commands/environ:usage}{{2.8.2}{18}{Usage}{subsection.2.8.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Configuration}{18}{subsection.2.8.3}}
+\newlabel{commands/environ:configuration}{{2.8.3}{18}{Configuration}{subsection.2.8.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command clean}{21}{section.2.9}}
+\newlabel{commands/clean:svn}{{2.9}{21}{Command clean}{section.2.9}{}}
+\newlabel{commands/clean:command-clean}{{2.9}{21}{Command clean}{section.2.9}{}}
+\newlabel{commands/clean::doc}{{2.9}{21}{Command clean}{section.2.9}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1}}
-\newlabel{commands/package:description}{{2.9.1}{21}{Description}{subsection.2.9.1}{}}
+\newlabel{commands/clean:description}{{2.9.1}{21}{Description}{subsection.2.9.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2}}
-\newlabel{commands/package:usage}{{2.9.2}{21}{Usage}{subsection.2.9.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3}}
-\newlabel{commands/package:some-useful-configuration-pathes}{{2.9.3}{22}{Some useful configuration pathes}{subsection.2.9.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10}}
-\newlabel{commands/generate:svn}{{2.10}{23}{Command generate}{section.2.10}{}}
-\newlabel{commands/generate:command-generate}{{2.10}{23}{Command generate}{section.2.10}{}}
-\newlabel{commands/generate::doc}{{2.10}{23}{Command generate}{section.2.10}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1}}
-\newlabel{commands/generate:description}{{2.10.1}{23}{Description}{subsection.2.10.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2}}
-\newlabel{commands/generate:remarks}{{2.10.2}{23}{Remarks}{subsection.2.10.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3}}
-\newlabel{commands/generate:usage}{{2.10.3}{23}{Usage}{subsection.2.10.3}{}}
+\newlabel{commands/clean:usage}{{2.9.2}{21}{Usage}{subsection.2.9.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Availables options}{21}{subsection.2.9.3}}
+\newlabel{commands/clean:availables-options}{{2.9.3}{21}{Availables options}{subsection.2.9.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.4}Some useful configuration pathes}{21}{subsection.2.9.4}}
+\newlabel{commands/clean:some-useful-configuration-pathes}{{2.9.4}{21}{Some useful configuration pathes}{subsection.2.9.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command package}{22}{section.2.10}}
+\newlabel{commands/package:svn}{{2.10}{22}{Command package}{section.2.10}{}}
+\newlabel{commands/package:command-package}{{2.10}{22}{Command package}{section.2.10}{}}
+\newlabel{commands/package::doc}{{2.10}{22}{Command package}{section.2.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{22}{subsection.2.10.1}}
+\newlabel{commands/package:description}{{2.10.1}{22}{Description}{subsection.2.10.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Usage}{22}{subsection.2.10.2}}
+\newlabel{commands/package:usage}{{2.10.2}{22}{Usage}{subsection.2.10.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Some useful configuration pathes}{23}{subsection.2.10.3}}
+\newlabel{commands/package:some-useful-configuration-pathes}{{2.10.3}{23}{Some useful configuration pathes}{subsection.2.10.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.11}Command generate}{24}{section.2.11}}
+\newlabel{commands/generate:svn}{{2.11}{24}{Command generate}{section.2.11}{}}
+\newlabel{commands/generate:command-generate}{{2.11}{24}{Command generate}{section.2.11}{}}
+\newlabel{commands/generate::doc}{{2.11}{24}{Command generate}{section.2.11}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.11.1}Description}{24}{subsection.2.11.1}}
+\newlabel{commands/generate:description}{{2.11.1}{24}{Description}{subsection.2.11.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.11.2}Remarks}{24}{subsection.2.11.2}}
+\newlabel{commands/generate:remarks}{{2.11.2}{24}{Remarks}{subsection.2.11.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.11.3}Usage}{24}{subsection.2.11.3}}
+\newlabel{commands/generate:usage}{{2.11.3}{24}{Usage}{subsection.2.11.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}src}{29}{section.4.1}}
\newlabel{commands/apidoc/modules:src}{{4.1}{29}{src}{section.4.1}{}}
\newlabel{commands/apidoc/modules::doc}{{4.1}{29}{src}{section.4.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src Package}{29}{subsection.4.1.1}}
-\newlabel{commands/apidoc/src::doc}{{4.1.1}{29}{src Package}{subsection.4.1.1}{}}
-\newlabel{commands/apidoc/src:src-package}{{4.1.1}{29}{src Package}{subsection.4.1.1}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{29}{subsubsection*.16}}
-\newlabel{commands/apidoc/src:id1}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{subsubsection*.16}{}}
-\newlabel{commands/apidoc/src:module-src.__init__}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.17}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.18}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.base}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.19}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.chmod}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.20}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.copy}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.21}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.copydir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.22}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.copyfile}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.23}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.copylink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.24}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.dir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.25}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.exists}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.26}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.isdir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.27}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.isfile}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.28}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.islink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.29}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.list}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.30}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.make}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.31}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.readlink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.32}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.rm}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.33}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.smartcopy}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.34}{}}
-\newlabel{commands/apidoc/src:src.__init__.Path.symlink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.35}{}}
-\newlabel{commands/apidoc/src:src.__init__.SatException}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.36}{}}
-\newlabel{commands/apidoc/src:src.__init__.activate_mesa_property}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.37}{}}
-\newlabel{commands/apidoc/src:src.__init__.check_config_has_application}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.38}{}}
-\newlabel{commands/apidoc/src:src.__init__.check_config_has_profile}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.39}{}}
-\newlabel{commands/apidoc/src:src.__init__.config_has_application}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.40}{}}
-\newlabel{commands/apidoc/src:src.__init__.deepcopy_list}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.41}{}}
-\newlabel{commands/apidoc/src:src.__init__.ensure_path_exists}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.42}{}}
-\newlabel{commands/apidoc/src:src.__init__.find_file_in_lpath}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.43}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_base_path}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.44}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_cfg_param}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.45}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_launcher_name}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.46}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_log_path}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.47}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_property_in_product_cfg}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.48}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_salome_version}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.49}{}}
-\newlabel{commands/apidoc/src:src.__init__.get_tmp_filename}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.50}{}}
-\newlabel{commands/apidoc/src:src.__init__.handleRemoveReadonly}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.51}{}}
-\newlabel{commands/apidoc/src:src.__init__.merge_dicts}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.52}{}}
-\newlabel{commands/apidoc/src:src.__init__.only_numbers}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.53}{}}
-\newlabel{commands/apidoc/src:src.__init__.parse_date}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.54}{}}
-\newlabel{commands/apidoc/src:src.__init__.print_info}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.55}{}}
-\newlabel{commands/apidoc/src:src.__init__.read_config_from_a_file}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.56}{}}
-\newlabel{commands/apidoc/src:src.__init__.remove_item_from_list}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.57}{}}
-\newlabel{commands/apidoc/src:src.__init__.replace_in_file}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.58}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{31}{subsubsection*.59}}
-\newlabel{commands/apidoc/src:elementtree-module}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{subsubsection*.59}{}}
-\newlabel{commands/apidoc/src:module-src.ElementTree}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{subsubsection*.59}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.Comment}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.60}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.dump}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.61}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.Element}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.62}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.63}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.find}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.64}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findall}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.65}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.66}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.67}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.68}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.parse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.69}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.write}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.70}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.fromstring}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.71}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.iselement}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.72}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.iterparse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.73}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.iterparse.next}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.74}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.parse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.75}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.PI}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.76}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.77}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.QName}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.78}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.SubElement}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.79}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.tostring}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.80}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.81}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.82}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.83}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.84}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.85}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.XML}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.86}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.87}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.88}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.89}{}}
-\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.90}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{32}{subsubsection*.91}}
-\newlabel{commands/apidoc/src:architecture-module}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{subsubsection*.91}{}}
-\newlabel{commands/apidoc/src:module-src.architecture}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{subsubsection*.91}{}}
-\newlabel{commands/apidoc/src:src.architecture.get_distrib_version}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.92}{}}
-\newlabel{commands/apidoc/src:src.architecture.get_distribution}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.93}{}}
-\newlabel{commands/apidoc/src:src.architecture.get_nb_proc}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.94}{}}
-\newlabel{commands/apidoc/src:src.architecture.get_python_version}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.95}{}}
-\newlabel{commands/apidoc/src:src.architecture.get_user}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.96}{}}
-\newlabel{commands/apidoc/src:src.architecture.is_windows}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.97}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{33}{subsubsection*.98}}
-\newlabel{commands/apidoc/src:module-src.compilation}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{subsubsection*.98}{}}
-\newlabel{commands/apidoc/src:compilation-module}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{subsubsection*.98}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.99}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.build_configure}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.100}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.check}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.101}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.cmake}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.102}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.complete_environment}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.103}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.configure}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.104}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.105}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.do_default_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.106}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.107}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.do_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.108}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.hack_libtool}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.109}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.install}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.110}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.log}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.111}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.log_command}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.112}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.make}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.113}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.prepare}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.114}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.115}{}}
-\newlabel{commands/apidoc/src:src.compilation.Builder.wmake}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.116}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{34}{subsubsection*.117}}
-\newlabel{commands/apidoc/src:module-src.debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{subsubsection*.117}{}}
-\newlabel{commands/apidoc/src:debug-module}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{subsubsection*.117}{}}
-\newlabel{commands/apidoc/src:src.debug.InStream}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.118}{}}
-\newlabel{commands/apidoc/src:src.debug.OutStream}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.119}{}}
-\newlabel{commands/apidoc/src:src.debug.OutStream.close}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.120}{}}
-\newlabel{commands/apidoc/src:src.debug.getLocalEnv}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.121}{}}
-\newlabel{commands/apidoc/src:src.debug.getStrConfigDbg}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.122}{}}
-\newlabel{commands/apidoc/src:src.debug.getStrConfigStd}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.123}{}}
-\newlabel{commands/apidoc/src:src.debug.indent}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.124}{}}
-\newlabel{commands/apidoc/src:src.debug.pop_debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.125}{}}
-\newlabel{commands/apidoc/src:src.debug.push_debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.126}{}}
-\newlabel{commands/apidoc/src:src.debug.saveConfigDbg}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.127}{}}
-\newlabel{commands/apidoc/src:src.debug.saveConfigStd}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.128}{}}
-\newlabel{commands/apidoc/src:src.debug.tofix}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.129}{}}
-\newlabel{commands/apidoc/src:src.debug.write}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.130}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{35}{subsubsection*.131}}
-\newlabel{commands/apidoc/src:environment-module}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{subsubsection*.131}{}}
-\newlabel{commands/apidoc/src:module-src.environment}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{subsubsection*.131}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.132}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.append}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.133}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.append_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.134}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.command_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.135}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.get}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.136}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.is_defined}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.137}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.prepend}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.138}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.prepend_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.139}{}}
-\newlabel{commands/apidoc/src:src.environment.Environ.set}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.140}{}}
-\newlabel{commands/apidoc/src:src.environment.FileEnvWriter}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.141}{}}
-\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.142}{}}
-\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.143}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.144}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.145}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.146}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.147}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.append}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.148}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.dump}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.149}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.finish}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.150}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.151}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.152}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.153}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.154}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.155}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.156}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.157}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.158}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.159}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.160}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.161}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.162}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.163}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.164}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.165}{}}
-\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.166}{}}
-\newlabel{commands/apidoc/src:src.environment.Shell}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.167}{}}
-\newlabel{commands/apidoc/src:src.environment.load_environment}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.168}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{39}{subsubsection*.169}}
-\newlabel{commands/apidoc/src:fileenviron-module}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{subsubsection*.169}{}}
-\newlabel{commands/apidoc/src:module-src.fileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{subsubsection*.169}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.170}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.171}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.172}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.173}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.174}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.175}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.176}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.177}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.178}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.179}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.180}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.181}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.182}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.183}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.184}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.185}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.186}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.187}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.188}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.189}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.190}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.191}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.192}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.193}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.194}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.195}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.196}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.197}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.198}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.199}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.200}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.201}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.202}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.203}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.204}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.205}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.206}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.207}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.208}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.209}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.210}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.211}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.212}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.213}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.214}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.215}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.216}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.217}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.218}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.219}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.220}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.221}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.222}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.223}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.224}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.225}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.226}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.227}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.228}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.229}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.230}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.231}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.get_file_environ}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.232}{}}
-\newlabel{commands/apidoc/src:src.fileEnviron.special_path_separator}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.233}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{45}{subsubsection*.234}}
-\newlabel{commands/apidoc/src:fork-module}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{subsubsection*.234}{}}
-\newlabel{commands/apidoc/src:module-src.fork}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{subsubsection*.234}{}}
-\newlabel{commands/apidoc/src:src.fork.batch}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.235}{}}
-\newlabel{commands/apidoc/src:src.fork.batch_salome}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.236}{}}
-\newlabel{commands/apidoc/src:src.fork.launch_command}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.237}{}}
-\newlabel{commands/apidoc/src:src.fork.show_progress}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.238}{}}
-\newlabel{commands/apidoc/src:src.fork.write_back}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.239}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{45}{subsubsection*.240}}
-\newlabel{commands/apidoc/src:logger-module}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{subsubsection*.240}{}}
-\newlabel{commands/apidoc/src:module-src.logger}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{subsubsection*.240}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.241}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.add_link}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.242}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.end_write}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.243}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.error}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.244}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.flush}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.245}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.246}{}}
-\newlabel{commands/apidoc/src:src.logger.Logger.write}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.247}{}}
-\newlabel{commands/apidoc/src:src.logger.date_to_datetime}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.248}{}}
-\newlabel{commands/apidoc/src:src.logger.list_log_file}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.249}{}}
-\newlabel{commands/apidoc/src:src.logger.show_command_log}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.250}{}}
-\newlabel{commands/apidoc/src:src.logger.timedelta_total_seconds}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.251}{}}
-\newlabel{commands/apidoc/src:src.logger.update_hat_xml}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.252}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{47}{subsubsection*.253}}
-\newlabel{commands/apidoc/src:module-src.options}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{subsubsection*.253}{}}
-\newlabel{commands/apidoc/src:options-module}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{subsubsection*.253}{}}
-\newlabel{commands/apidoc/src:src.options.OptResult}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.254}{}}
-\newlabel{commands/apidoc/src:src.options.Options}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.255}{}}
-\newlabel{commands/apidoc/src:src.options.Options.add_option}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.256}{}}
-\newlabel{commands/apidoc/src:src.options.Options.parse_args}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.257}{}}
-\newlabel{commands/apidoc/src:src.options.Options.print_help}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.258}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{47}{subsubsection*.259}}
-\newlabel{commands/apidoc/src:printcolors-module}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{subsubsection*.259}{}}
-\newlabel{commands/apidoc/src:module-src.printcolors}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{subsubsection*.259}{}}
-\newlabel{commands/apidoc/src:src.printcolors.cleancolor}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.260}{}}
-\newlabel{commands/apidoc/src:src.printcolors.print_color_map}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.261}{}}
-\newlabel{commands/apidoc/src:src.printcolors.print_color_range}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.262}{}}
-\newlabel{commands/apidoc/src:src.printcolors.print_value}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.263}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printc}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.264}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcError}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.265}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcHeader}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.266}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcHighlight}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.267}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcInfo}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.268}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcLabel}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.269}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcSuccess}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.270}{}}
-\newlabel{commands/apidoc/src:src.printcolors.printcWarning}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.271}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{49}{subsubsection*.272}}
-\newlabel{commands/apidoc/src:module-src.product}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{subsubsection*.272}{}}
-\newlabel{commands/apidoc/src:product-module}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{subsubsection*.272}{}}
-\newlabel{commands/apidoc/src:src.product.check_config_exists}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.273}{}}
-\newlabel{commands/apidoc/src:src.product.check_installation}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.274}{}}
-\newlabel{commands/apidoc/src:src.product.check_source}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.275}{}}
-\newlabel{commands/apidoc/src:src.product.get_base_install_dir}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.276}{}}
-\newlabel{commands/apidoc/src:src.product.get_install_dir}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.277}{}}
-\newlabel{commands/apidoc/src:src.product.get_product_components}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.278}{}}
-\newlabel{commands/apidoc/src:src.product.get_product_config}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.279}{}}
-\newlabel{commands/apidoc/src:src.product.get_product_dependencies}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.280}{}}
-\newlabel{commands/apidoc/src:src.product.get_product_section}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.281}{}}
-\newlabel{commands/apidoc/src:src.product.get_products_infos}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.282}{}}
-\newlabel{commands/apidoc/src:src.product.product_compiles}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.283}{}}
-\newlabel{commands/apidoc/src:src.product.product_has_env_script}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.284}{}}
-\newlabel{commands/apidoc/src:src.product.product_has_logo}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.285}{}}
-\newlabel{commands/apidoc/src:src.product.product_has_patches}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.286}{}}
-\newlabel{commands/apidoc/src:src.product.product_has_salome_gui}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.287}{}}
-\newlabel{commands/apidoc/src:src.product.product_has_script}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.288}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_autotools}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.289}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_cmake}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.290}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_cpp}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.291}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_debug}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.292}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_dev}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.293}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_fixed}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.294}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_generated}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.295}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_mpi}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.296}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_native}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.297}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_salome}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.298}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_sample}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.299}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_smesh_plugin}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.300}{}}
-\newlabel{commands/apidoc/src:src.product.product_is_vcs}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.301}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{53}{subsubsection*.302}}
-\newlabel{commands/apidoc/src:pyconf-module}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{subsubsection*.302}{}}
-\newlabel{commands/apidoc/src:module-src.pyconf}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{subsubsection*.302}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.303}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config.Namespace}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.304}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config.addNamespace}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.305}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config.getByPath}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.306}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config.load}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.307}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Config.removeNamespace}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.308}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigError}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.309}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigFormatError}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.310}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.311}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.312}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.313}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.314}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigList}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.315}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.316}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.317}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.318}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.319}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.320}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.321}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.322}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.323}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.324}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.325}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.326}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.327}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.328}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.329}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.load}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.330}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.location}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.331}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.match}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.332}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.333}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.334}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.335}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.336}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.337}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.338}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.339}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.340}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.341}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.342}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.343}{}}
-\newlabel{commands/apidoc/src:src.pyconf.ConfigResolutionError}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.344}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Container}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.345}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Container.evaluate}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.346}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Container.setPath}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.347}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Container.writeToStream}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.348}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Container.writeValue}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.349}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Expression}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.350}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Expression.evaluate}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.351}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.352}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.addMapping}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.353}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.get}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.354}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.iteritems}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.355}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.356}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.keys}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.357}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.358}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Reference}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.359}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Reference.addElement}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.360}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Reference.findConfig}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.361}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Reference.resolve}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.362}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Sequence}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.363}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.364}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.365}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Sequence.append}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.366}{}}
-\newlabel{commands/apidoc/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.367}{}}
-\newlabel{commands/apidoc/src:src.pyconf.deepCopyMapping}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.368}{}}
-\newlabel{commands/apidoc/src:src.pyconf.defaultMergeResolve}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.369}{}}
-\newlabel{commands/apidoc/src:src.pyconf.defaultStreamOpener}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.370}{}}
-\newlabel{commands/apidoc/src:src.pyconf.isWord}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.371}{}}
-\newlabel{commands/apidoc/src:src.pyconf.makePath}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.372}{}}
-\newlabel{commands/apidoc/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.373}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{60}{subsubsection*.374}}
-\newlabel{commands/apidoc/src:system-module}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{subsubsection*.374}{}}
-\newlabel{commands/apidoc/src:module-src.system}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{subsubsection*.374}{}}
-\newlabel{commands/apidoc/src:src.system.archive_extract}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.375}{}}
-\newlabel{commands/apidoc/src:src.system.cvs_extract}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.376}{}}
-\newlabel{commands/apidoc/src:src.system.git_extract}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.377}{}}
-\newlabel{commands/apidoc/src:src.system.show_in_editor}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.378}{}}
-\newlabel{commands/apidoc/src:src.system.svn_extract}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.379}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{62}{subsubsection*.380}}
-\newlabel{commands/apidoc/src:template-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{subsubsection*.380}{}}
-\newlabel{commands/apidoc/src:module-src.template}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{subsubsection*.380}{}}
-\newlabel{commands/apidoc/src:src.template.MyTemplate}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.381}{}}
-\newlabel{commands/apidoc/src:src.template.MyTemplate.delimiter}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.382}{}}
-\newlabel{commands/apidoc/src:src.template.MyTemplate.pattern}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.383}{}}
-\newlabel{commands/apidoc/src:src.template.substitute}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.384}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{62}{subsubsection*.385}}
-\newlabel{commands/apidoc/src:module-src.test_module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{subsubsection*.385}{}}
-\newlabel{commands/apidoc/src:test-module-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{subsubsection*.385}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.386}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.387}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.generate_script}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.388}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.get_test_timeout}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.389}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.390}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.391}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.392}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.393}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.394}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.read_results}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.395}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_all_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.396}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_grid_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.397}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_script}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.398}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_session_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.399}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.400}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.run_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.401}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.search_known_errors}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.402}{}}
-\newlabel{commands/apidoc/src:src.test_module.Test.write_test_margin}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.403}{}}
-\newlabel{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.404}{}}
-\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{62}{subsubsection*.405}}
-\newlabel{commands/apidoc/src:xmlmanager-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{subsubsection*.405}{}}
-\newlabel{commands/apidoc/src:module-src.xmlManager}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{subsubsection*.405}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.406}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.407}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.408}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.409}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.410}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.411}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.412}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.413}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.414}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.add_simple_node}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.415}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.append_node_attrib}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.416}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.417}{}}
-\newlabel{commands/apidoc/src:src.xmlManager.write_report}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.418}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{64}{subsubsection*.419}}
-\newlabel{commands/apidoc/src:subpackages}{{4.1.1}{64}{Subpackages}{subsubsection*.419}{}}
-\@writefile{toc}{\contentsline {paragraph}{colorama Package}{64}{paragraph*.420}}
-\newlabel{commands/apidoc/src.colorama:colorama-package}{{4.1.1}{64}{colorama Package}{paragraph*.420}{}}
-\newlabel{commands/apidoc/src.colorama::doc}{{4.1.1}{64}{colorama Package}{paragraph*.420}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{64}{subparagraph*.421}}
-\newlabel{commands/apidoc/src.colorama:id1}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{subparagraph*.421}{}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{section*.422}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{64}{subparagraph*.423}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansi}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{subparagraph*.423}{}}
-\newlabel{commands/apidoc/src.colorama:ansi-module}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{subparagraph*.423}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.424}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.425}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.426}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.427}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.428}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.429}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.430}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.431}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.432}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.433}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.434}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.435}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.436}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.437}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.438}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.439}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.440}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.441}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.442}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.443}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.444}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.445}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.446}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.447}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.448}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.449}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.450}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.451}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.452}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.453}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.454}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.455}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.456}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.457}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.458}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.459}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.460}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.461}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.462}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.463}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.464}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.465}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.466}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.467}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.468}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.469}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.470}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.471}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.472}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.473}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.474}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.475}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{66}{subparagraph*.476}}
-\newlabel{commands/apidoc/src.colorama:ansitowin32-module}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{subparagraph*.476}{}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{subparagraph*.476}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.477}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.478}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.479}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.480}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.481}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.482}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.483}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.484}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.485}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.486}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.487}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.488}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.489}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.490}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.491}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.492}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.493}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{67}{subparagraph*.494}}
-\newlabel{commands/apidoc/src.colorama:initialise-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{subparagraph*.494}{}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama.initialise}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{subparagraph*.494}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.495}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.496}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.init}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.497}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.498}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.499}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.500}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{67}{subparagraph*.501}}
-\newlabel{commands/apidoc/src.colorama:win32-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{subparagraph*.501}{}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama.win32}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{subparagraph*.501}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{section*.502}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{section*.503}{}}
-\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{67}{subparagraph*.504}}
-\newlabel{commands/apidoc/src.colorama:winterm-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{subparagraph*.504}{}}
-\newlabel{commands/apidoc/src.colorama:module-src.colorama.winterm}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{subparagraph*.504}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.505}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.506}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.507}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.508}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.509}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.510}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.511}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.512}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.513}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.514}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.515}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.516}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.517}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.518}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.519}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.520}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.521}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.522}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.523}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.524}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.525}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.526}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.527}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.528}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.529}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.530}{}}
-\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.531}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src package}{29}{subsection.4.1.1}}
+\newlabel{commands/apidoc/src::doc}{{4.1.1}{29}{src package}{subsection.4.1.1}{}}
+\newlabel{commands/apidoc/src:src-package}{{4.1.1}{29}{src package}{subsection.4.1.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{29}{subsubsection*.16}}
+\newlabel{commands/apidoc/src:subpackages}{{4.1.1}{29}{Subpackages}{subsubsection*.16}{}}
+\@writefile{toc}{\contentsline {paragraph}{src.colorama package}{29}{paragraph*.17}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-package}{{4.1.1}{29}{src.colorama package}{paragraph*.17}{}}
+\newlabel{commands/apidoc/src.colorama::doc}{{4.1.1}{29}{src.colorama package}{paragraph*.17}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Submodules}{29}{subparagraph*.18}}
+\newlabel{commands/apidoc/src.colorama:submodules}{{4.1.1}{29}{Submodules}{subparagraph*.18}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.ansi module}{29}{subparagraph*.19}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansi}{{4.1.1}{29}{src.colorama.ansi module}{subparagraph*.19}{}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-ansi-module}{{4.1.1}{29}{src.colorama.ansi module}{subparagraph*.19}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{29}{src.colorama.ansi module}{section*.20}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{29}{src.colorama.ansi module}{section*.21}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{29}{src.colorama.ansi module}{section*.22}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{29}{src.colorama.ansi module}{section*.23}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{29}{src.colorama.ansi module}{section*.24}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.25}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.26}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.27}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.28}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.29}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.30}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.31}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.32}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{29}{src.colorama.ansi module}{section*.33}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{29}{src.colorama.ansi module}{section*.34}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{29}{src.colorama.ansi module}{section*.35}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{29}{src.colorama.ansi module}{section*.36}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{29}{src.colorama.ansi module}{section*.37}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{29}{src.colorama.ansi module}{section*.38}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{30}{src.colorama.ansi module}{section*.39}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{30}{src.colorama.ansi module}{section*.40}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{30}{src.colorama.ansi module}{section*.41}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{30}{src.colorama.ansi module}{section*.42}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{30}{src.colorama.ansi module}{section*.43}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{30}{src.colorama.ansi module}{section*.44}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{30}{src.colorama.ansi module}{section*.45}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{30}{src.colorama.ansi module}{section*.46}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{30}{src.colorama.ansi module}{section*.47}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{30}{src.colorama.ansi module}{section*.48}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{30}{src.colorama.ansi module}{section*.49}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.50}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.51}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.52}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.53}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.54}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.55}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.56}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.57}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{30}{src.colorama.ansi module}{section*.58}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{30}{src.colorama.ansi module}{section*.59}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{30}{src.colorama.ansi module}{section*.60}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{30}{src.colorama.ansi module}{section*.61}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{30}{src.colorama.ansi module}{section*.62}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{30}{src.colorama.ansi module}{section*.63}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{30}{src.colorama.ansi module}{section*.64}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{30}{src.colorama.ansi module}{section*.65}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{30}{src.colorama.ansi module}{section*.66}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{30}{src.colorama.ansi module}{section*.67}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{30}{src.colorama.ansi module}{section*.68}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{30}{src.colorama.ansi module}{section*.69}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{30}{src.colorama.ansi module}{section*.70}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{30}{src.colorama.ansi module}{section*.71}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.ansitowin32 module}{31}{subparagraph*.72}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{subparagraph*.72}{}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-ansitowin32-module}{{4.1.1}{31}{src.colorama.ansitowin32 module}{subparagraph*.72}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.73}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.74}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.75}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.76}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.77}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.78}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.79}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.80}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.81}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.82}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.83}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.84}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.85}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.86}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.87}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.88}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.89}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.initialise module}{31}{subparagraph*.90}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-initialise-module}{{4.1.1}{31}{src.colorama.initialise module}{subparagraph*.90}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.initialise}{{4.1.1}{31}{src.colorama.initialise module}{subparagraph*.90}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{31}{src.colorama.initialise module}{section*.91}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{31}{src.colorama.initialise module}{section*.92}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.init}{{4.1.1}{31}{src.colorama.initialise module}{section*.93}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{31}{src.colorama.initialise module}{section*.94}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{31}{src.colorama.initialise module}{section*.95}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{31}{src.colorama.initialise module}{section*.96}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.win32 module}{32}{subparagraph*.97}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-win32-module}{{4.1.1}{32}{src.colorama.win32 module}{subparagraph*.97}{}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.win32}{{4.1.1}{32}{src.colorama.win32 module}{subparagraph*.97}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{32}{src.colorama.win32 module}{section*.98}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{32}{src.colorama.win32 module}{section*.99}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.winterm module}{32}{subparagraph*.100}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama.winterm}{{4.1.1}{32}{src.colorama.winterm module}{subparagraph*.100}{}}
+\newlabel{commands/apidoc/src.colorama:src-colorama-winterm-module}{{4.1.1}{32}{src.colorama.winterm module}{subparagraph*.100}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{32}{src.colorama.winterm module}{section*.101}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{32}{src.colorama.winterm module}{section*.102}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{32}{src.colorama.winterm module}{section*.103}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{32}{src.colorama.winterm module}{section*.104}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{32}{src.colorama.winterm module}{section*.105}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{32}{src.colorama.winterm module}{section*.106}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{32}{src.colorama.winterm module}{section*.107}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{32}{src.colorama.winterm module}{section*.108}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{32}{src.colorama.winterm module}{section*.109}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{32}{src.colorama.winterm module}{section*.110}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{32}{src.colorama.winterm module}{section*.111}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{32}{src.colorama.winterm module}{section*.112}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{32}{src.colorama.winterm module}{section*.113}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{32}{src.colorama.winterm module}{section*.114}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{32}{src.colorama.winterm module}{section*.115}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{32}{src.colorama.winterm module}{section*.116}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{32}{src.colorama.winterm module}{section*.117}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{32}{src.colorama.winterm module}{section*.118}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{32}{src.colorama.winterm module}{section*.119}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{32}{src.colorama.winterm module}{section*.120}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{32}{src.colorama.winterm module}{section*.121}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{32}{src.colorama.winterm module}{section*.122}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{32}{src.colorama.winterm module}{section*.123}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{32}{src.colorama.winterm module}{section*.124}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{32}{src.colorama.winterm module}{section*.125}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{32}{src.colorama.winterm module}{section*.126}{}}
+\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{32}{src.colorama.winterm module}{section*.127}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Module contents}{33}{subparagraph*.128}}
+\newlabel{commands/apidoc/src.colorama:module-src.colorama}{{4.1.1}{33}{Module contents}{subparagraph*.128}{}}
+\newlabel{commands/apidoc/src.colorama:module-contents}{{4.1.1}{33}{Module contents}{subparagraph*.128}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Submodules}{33}{subsubsection*.129}}
+\newlabel{commands/apidoc/src:submodules}{{4.1.1}{33}{Submodules}{subsubsection*.129}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.ElementTree module}{33}{subsubsection*.130}}
+\newlabel{commands/apidoc/src:src-elementtree-module}{{4.1.1}{33}{src.ElementTree module}{subsubsection*.130}{}}
+\newlabel{commands/apidoc/src:module-src.ElementTree}{{4.1.1}{33}{src.ElementTree module}{subsubsection*.130}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.Comment}{{4.1.1}{33}{src.ElementTree module}{section*.131}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.dump}{{4.1.1}{33}{src.ElementTree module}{section*.132}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.Element}{{4.1.1}{33}{src.ElementTree module}{section*.133}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree}{{4.1.1}{33}{src.ElementTree module}{section*.134}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.find}{{4.1.1}{33}{src.ElementTree module}{section*.135}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findall}{{4.1.1}{33}{src.ElementTree module}{section*.136}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{33}{src.ElementTree module}{section*.137}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{33}{src.ElementTree module}{section*.138}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{33}{src.ElementTree module}{section*.139}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.parse}{{4.1.1}{33}{src.ElementTree module}{section*.140}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.write}{{4.1.1}{33}{src.ElementTree module}{section*.141}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.fromstring}{{4.1.1}{33}{src.ElementTree module}{section*.142}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iselement}{{4.1.1}{33}{src.ElementTree module}{section*.143}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iterparse}{{4.1.1}{33}{src.ElementTree module}{section*.144}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.iterparse.next}{{4.1.1}{33}{src.ElementTree module}{section*.145}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.parse}{{4.1.1}{33}{src.ElementTree module}{section*.146}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.PI}{{4.1.1}{33}{src.ElementTree module}{section*.147}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{33}{src.ElementTree module}{section*.148}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.QName}{{4.1.1}{33}{src.ElementTree module}{section*.149}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.SubElement}{{4.1.1}{33}{src.ElementTree module}{section*.150}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.tostring}{{4.1.1}{33}{src.ElementTree module}{section*.151}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder}{{4.1.1}{33}{src.ElementTree module}{section*.152}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{33}{src.ElementTree module}{section*.153}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{33}{src.ElementTree module}{section*.154}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{33}{src.ElementTree module}{section*.155}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{33}{src.ElementTree module}{section*.156}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XML}{{4.1.1}{33}{src.ElementTree module}{section*.157}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{33}{src.ElementTree module}{section*.158}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{33}{src.ElementTree module}{section*.159}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{33}{src.ElementTree module}{section*.160}{}}
+\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{33}{src.ElementTree module}{section*.161}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.architecture module}{34}{subsubsection*.162}}
+\newlabel{commands/apidoc/src:module-src.architecture}{{4.1.1}{34}{src.architecture module}{subsubsection*.162}{}}
+\newlabel{commands/apidoc/src:src-architecture-module}{{4.1.1}{34}{src.architecture module}{subsubsection*.162}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_distrib_version}{{4.1.1}{34}{src.architecture module}{section*.163}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_distribution}{{4.1.1}{34}{src.architecture module}{section*.164}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_nb_proc}{{4.1.1}{34}{src.architecture module}{section*.165}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_python_version}{{4.1.1}{34}{src.architecture module}{section*.166}{}}
+\newlabel{commands/apidoc/src:src.architecture.get_user}{{4.1.1}{34}{src.architecture module}{section*.167}{}}
+\newlabel{commands/apidoc/src:src.architecture.is_windows}{{4.1.1}{34}{src.architecture module}{section*.168}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.compilation module}{34}{subsubsection*.169}}
+\newlabel{commands/apidoc/src:module-src.compilation}{{4.1.1}{34}{src.compilation module}{subsubsection*.169}{}}
+\newlabel{commands/apidoc/src:src-compilation-module}{{4.1.1}{34}{src.compilation module}{subsubsection*.169}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder}{{4.1.1}{34}{src.compilation module}{section*.170}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.build_configure}{{4.1.1}{34}{src.compilation module}{section*.171}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.check}{{4.1.1}{34}{src.compilation module}{section*.172}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.cmake}{{4.1.1}{34}{src.compilation module}{section*.173}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.complete_environment}{{4.1.1}{34}{src.compilation module}{section*.174}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.configure}{{4.1.1}{34}{src.compilation module}{section*.175}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{34}{src.compilation module}{section*.176}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_default_build}{{4.1.1}{34}{src.compilation module}{section*.177}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{35}{src.compilation module}{section*.178}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.do_script_build}{{4.1.1}{35}{src.compilation module}{section*.179}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.hack_libtool}{{4.1.1}{35}{src.compilation module}{section*.180}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.install}{{4.1.1}{35}{src.compilation module}{section*.181}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.log}{{4.1.1}{35}{src.compilation module}{section*.182}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.log_command}{{4.1.1}{35}{src.compilation module}{section*.183}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.make}{{4.1.1}{35}{src.compilation module}{section*.184}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.prepare}{{4.1.1}{35}{src.compilation module}{section*.185}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{35}{src.compilation module}{section*.186}{}}
+\newlabel{commands/apidoc/src:src.compilation.Builder.wmake}{{4.1.1}{35}{src.compilation module}{section*.187}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.debug module}{35}{subsubsection*.188}}
+\newlabel{commands/apidoc/src:module-src.debug}{{4.1.1}{35}{src.debug module}{subsubsection*.188}{}}
+\newlabel{commands/apidoc/src:src-debug-module}{{4.1.1}{35}{src.debug module}{subsubsection*.188}{}}
+\newlabel{commands/apidoc/src:src.debug.InStream}{{4.1.1}{35}{src.debug module}{section*.189}{}}
+\newlabel{commands/apidoc/src:src.debug.OutStream}{{4.1.1}{35}{src.debug module}{section*.190}{}}
+\newlabel{commands/apidoc/src:src.debug.OutStream.close}{{4.1.1}{35}{src.debug module}{section*.191}{}}
+\newlabel{commands/apidoc/src:src.debug.getLocalEnv}{{4.1.1}{35}{src.debug module}{section*.192}{}}
+\newlabel{commands/apidoc/src:src.debug.getStrConfigDbg}{{4.1.1}{35}{src.debug module}{section*.193}{}}
+\newlabel{commands/apidoc/src:src.debug.getStrConfigStd}{{4.1.1}{36}{src.debug module}{section*.194}{}}
+\newlabel{commands/apidoc/src:src.debug.indent}{{4.1.1}{36}{src.debug module}{section*.195}{}}
+\newlabel{commands/apidoc/src:src.debug.pop_debug}{{4.1.1}{36}{src.debug module}{section*.196}{}}
+\newlabel{commands/apidoc/src:src.debug.push_debug}{{4.1.1}{36}{src.debug module}{section*.197}{}}
+\newlabel{commands/apidoc/src:src.debug.saveConfigDbg}{{4.1.1}{36}{src.debug module}{section*.198}{}}
+\newlabel{commands/apidoc/src:src.debug.saveConfigStd}{{4.1.1}{36}{src.debug module}{section*.199}{}}
+\newlabel{commands/apidoc/src:src.debug.tofix}{{4.1.1}{36}{src.debug module}{section*.200}{}}
+\newlabel{commands/apidoc/src:src.debug.write}{{4.1.1}{36}{src.debug module}{section*.201}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.environment module}{36}{subsubsection*.202}}
+\newlabel{commands/apidoc/src:src-environment-module}{{4.1.1}{36}{src.environment module}{subsubsection*.202}{}}
+\newlabel{commands/apidoc/src:module-src.environment}{{4.1.1}{36}{src.environment module}{subsubsection*.202}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ}{{4.1.1}{36}{src.environment module}{section*.203}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.append}{{4.1.1}{36}{src.environment module}{section*.204}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.append_value}{{4.1.1}{36}{src.environment module}{section*.205}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.command_value}{{4.1.1}{36}{src.environment module}{section*.206}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.get}{{4.1.1}{36}{src.environment module}{section*.207}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.is_defined}{{4.1.1}{36}{src.environment module}{section*.208}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.prepend}{{4.1.1}{37}{src.environment module}{section*.209}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.prepend_value}{{4.1.1}{37}{src.environment module}{section*.210}{}}
+\newlabel{commands/apidoc/src:src.environment.Environ.set}{{4.1.1}{37}{src.environment module}{section*.211}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter}{{4.1.1}{37}{src.environment module}{section*.212}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{37}{src.environment module}{section*.213}{}}
+\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{37}{src.environment module}{section*.214}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron}{{4.1.1}{37}{src.environment module}{section*.215}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{37}{src.environment module}{section*.216}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{38}{src.environment module}{section*.217}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{38}{src.environment module}{section*.218}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.append}{{4.1.1}{38}{src.environment module}{section*.219}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.dump}{{4.1.1}{38}{src.environment module}{section*.220}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.finish}{{4.1.1}{38}{src.environment module}{section*.221}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get}{{4.1.1}{38}{src.environment module}{section*.222}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{38}{src.environment module}{section*.223}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{38}{src.environment module}{section*.224}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{38}{src.environment module}{section*.225}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{38}{src.environment module}{section*.226}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{38}{src.environment module}{section*.227}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{39}{src.environment module}{section*.228}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set}{{4.1.1}{39}{src.environment module}{section*.229}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{39}{src.environment module}{section*.230}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{39}{src.environment module}{section*.231}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{39}{src.environment module}{section*.232}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{39}{src.environment module}{section*.233}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{39}{src.environment module}{section*.234}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{39}{src.environment module}{section*.235}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{39}{src.environment module}{section*.236}{}}
+\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{39}{src.environment module}{section*.237}{}}
+\newlabel{commands/apidoc/src:src.environment.Shell}{{4.1.1}{40}{src.environment module}{section*.238}{}}
+\newlabel{commands/apidoc/src:src.environment.load_environment}{{4.1.1}{40}{src.environment module}{section*.239}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.fileEnviron module}{40}{subsubsection*.240}}
+\newlabel{commands/apidoc/src:src-fileenviron-module}{{4.1.1}{40}{src.fileEnviron module}{subsubsection*.240}{}}
+\newlabel{commands/apidoc/src:module-src.fileEnviron}{{4.1.1}{40}{src.fileEnviron module}{subsubsection*.240}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{40}{src.fileEnviron module}{section*.241}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{40}{src.fileEnviron module}{section*.242}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{40}{src.fileEnviron module}{section*.243}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{40}{src.fileEnviron module}{section*.244}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{40}{src.fileEnviron module}{section*.245}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{40}{src.fileEnviron module}{section*.246}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{40}{src.fileEnviron module}{section*.247}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{40}{src.fileEnviron module}{section*.248}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{41}{src.fileEnviron module}{section*.249}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{41}{src.fileEnviron module}{section*.250}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{41}{src.fileEnviron module}{section*.251}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{41}{src.fileEnviron module}{section*.252}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{41}{src.fileEnviron module}{section*.253}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{41}{src.fileEnviron module}{section*.254}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{41}{src.fileEnviron module}{section*.255}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{41}{src.fileEnviron module}{section*.256}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{41}{src.fileEnviron module}{section*.257}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{41}{src.fileEnviron module}{section*.258}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{41}{src.fileEnviron module}{section*.259}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron}{{4.1.1}{42}{src.fileEnviron module}{section*.260}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{42}{src.fileEnviron module}{section*.261}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{42}{src.fileEnviron module}{section*.262}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{42}{src.fileEnviron module}{section*.263}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{42}{src.fileEnviron module}{section*.264}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{42}{src.fileEnviron module}{section*.265}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{42}{src.fileEnviron module}{section*.266}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{42}{src.fileEnviron module}{section*.267}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{42}{src.fileEnviron module}{section*.268}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{42}{src.fileEnviron module}{section*.269}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{43}{src.fileEnviron module}{section*.270}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{43}{src.fileEnviron module}{section*.271}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{43}{src.fileEnviron module}{section*.272}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{43}{src.fileEnviron module}{section*.273}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{43}{src.fileEnviron module}{section*.274}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{43}{src.fileEnviron module}{section*.275}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{43}{src.fileEnviron module}{section*.276}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{43}{src.fileEnviron module}{section*.277}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{43}{src.fileEnviron module}{section*.278}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{43}{src.fileEnviron module}{section*.279}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{43}{src.fileEnviron module}{section*.280}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{44}{src.fileEnviron module}{section*.281}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{44}{src.fileEnviron module}{section*.282}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{44}{src.fileEnviron module}{section*.283}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{44}{src.fileEnviron module}{section*.284}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{44}{src.fileEnviron module}{section*.285}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{44}{src.fileEnviron module}{section*.286}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{44}{src.fileEnviron module}{section*.287}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{44}{src.fileEnviron module}{section*.288}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{44}{src.fileEnviron module}{section*.289}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{44}{src.fileEnviron module}{section*.290}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{45}{src.fileEnviron module}{section*.291}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{45}{src.fileEnviron module}{section*.292}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{45}{src.fileEnviron module}{section*.293}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{45}{src.fileEnviron module}{section*.294}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{45}{src.fileEnviron module}{section*.295}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{45}{src.fileEnviron module}{section*.296}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{45}{src.fileEnviron module}{section*.297}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{45}{src.fileEnviron module}{section*.298}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{45}{src.fileEnviron module}{section*.299}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{45}{src.fileEnviron module}{section*.300}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{45}{src.fileEnviron module}{section*.301}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{46}{src.fileEnviron module}{section*.302}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.get_file_environ}{{4.1.1}{46}{src.fileEnviron module}{section*.303}{}}
+\newlabel{commands/apidoc/src:src.fileEnviron.special_path_separator}{{4.1.1}{46}{src.fileEnviron module}{section*.304}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.fork module}{46}{subsubsection*.305}}
+\newlabel{commands/apidoc/src:module-src.fork}{{4.1.1}{46}{src.fork module}{subsubsection*.305}{}}
+\newlabel{commands/apidoc/src:src-fork-module}{{4.1.1}{46}{src.fork module}{subsubsection*.305}{}}
+\newlabel{commands/apidoc/src:src.fork.batch}{{4.1.1}{46}{src.fork module}{section*.306}{}}
+\newlabel{commands/apidoc/src:src.fork.batch_salome}{{4.1.1}{46}{src.fork module}{section*.307}{}}
+\newlabel{commands/apidoc/src:src.fork.launch_command}{{4.1.1}{46}{src.fork module}{section*.308}{}}
+\newlabel{commands/apidoc/src:src.fork.show_progress}{{4.1.1}{46}{src.fork module}{section*.309}{}}
+\newlabel{commands/apidoc/src:src.fork.write_back}{{4.1.1}{46}{src.fork module}{section*.310}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.logger module}{46}{subsubsection*.311}}
+\newlabel{commands/apidoc/src:module-src.logger}{{4.1.1}{46}{src.logger module}{subsubsection*.311}{}}
+\newlabel{commands/apidoc/src:src-logger-module}{{4.1.1}{46}{src.logger module}{subsubsection*.311}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger}{{4.1.1}{46}{src.logger module}{section*.312}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.add_link}{{4.1.1}{46}{src.logger module}{section*.313}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.end_write}{{4.1.1}{47}{src.logger module}{section*.314}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.error}{{4.1.1}{47}{src.logger module}{section*.315}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.flush}{{4.1.1}{47}{src.logger module}{section*.316}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}{{4.1.1}{47}{src.logger module}{section*.317}{}}
+\newlabel{commands/apidoc/src:src.logger.Logger.write}{{4.1.1}{47}{src.logger module}{section*.318}{}}
+\newlabel{commands/apidoc/src:src.logger.date_to_datetime}{{4.1.1}{47}{src.logger module}{section*.319}{}}
+\newlabel{commands/apidoc/src:src.logger.list_log_file}{{4.1.1}{47}{src.logger module}{section*.320}{}}
+\newlabel{commands/apidoc/src:src.logger.show_command_log}{{4.1.1}{47}{src.logger module}{section*.321}{}}
+\newlabel{commands/apidoc/src:src.logger.timedelta_total_seconds}{{4.1.1}{47}{src.logger module}{section*.322}{}}
+\newlabel{commands/apidoc/src:src.logger.update_hat_xml}{{4.1.1}{48}{src.logger module}{section*.323}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.options module}{48}{subsubsection*.324}}
+\newlabel{commands/apidoc/src:module-src.options}{{4.1.1}{48}{src.options module}{subsubsection*.324}{}}
+\newlabel{commands/apidoc/src:src-options-module}{{4.1.1}{48}{src.options module}{subsubsection*.324}{}}
+\newlabel{commands/apidoc/src:src.options.OptResult}{{4.1.1}{48}{src.options module}{section*.325}{}}
+\newlabel{commands/apidoc/src:src.options.Options}{{4.1.1}{48}{src.options module}{section*.326}{}}
+\newlabel{commands/apidoc/src:src.options.Options.add_option}{{4.1.1}{48}{src.options module}{section*.327}{}}
+\newlabel{commands/apidoc/src:src.options.Options.debug_write}{{4.1.1}{48}{src.options module}{section*.328}{}}
+\newlabel{commands/apidoc/src:src.options.Options.filterLevel}{{4.1.1}{48}{src.options module}{section*.329}{}}
+\newlabel{commands/apidoc/src:src.options.Options.filterList2}{{4.1.1}{48}{src.options module}{section*.330}{}}
+\newlabel{commands/apidoc/src:src.options.Options.getDetailOption}{{4.1.1}{48}{src.options module}{section*.331}{}}
+\newlabel{commands/apidoc/src:src.options.Options.get_help}{{4.1.1}{49}{src.options module}{section*.332}{}}
+\newlabel{commands/apidoc/src:src.options.Options.indent}{{4.1.1}{49}{src.options module}{section*.333}{}}
+\newlabel{commands/apidoc/src:src.options.Options.parse_args}{{4.1.1}{49}{src.options module}{section*.334}{}}
+\newlabel{commands/apidoc/src:src.options.Options.print_help}{{4.1.1}{49}{src.options module}{section*.335}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.printcolors module}{49}{subsubsection*.336}}
+\newlabel{commands/apidoc/src:module-src.printcolors}{{4.1.1}{49}{src.printcolors module}{subsubsection*.336}{}}
+\newlabel{commands/apidoc/src:src-printcolors-module}{{4.1.1}{49}{src.printcolors module}{subsubsection*.336}{}}
+\newlabel{commands/apidoc/src:src.printcolors.cleancolor}{{4.1.1}{49}{src.printcolors module}{section*.337}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_color_map}{{4.1.1}{49}{src.printcolors module}{section*.338}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_color_range}{{4.1.1}{49}{src.printcolors module}{section*.339}{}}
+\newlabel{commands/apidoc/src:src.printcolors.print_value}{{4.1.1}{49}{src.printcolors module}{section*.340}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printc}{{4.1.1}{49}{src.printcolors module}{section*.341}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcError}{{4.1.1}{50}{src.printcolors module}{section*.342}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcHeader}{{4.1.1}{50}{src.printcolors module}{section*.343}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcHighlight}{{4.1.1}{50}{src.printcolors module}{section*.344}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcInfo}{{4.1.1}{50}{src.printcolors module}{section*.345}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcLabel}{{4.1.1}{50}{src.printcolors module}{section*.346}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcSuccess}{{4.1.1}{50}{src.printcolors module}{section*.347}{}}
+\newlabel{commands/apidoc/src:src.printcolors.printcWarning}{{4.1.1}{50}{src.printcolors module}{section*.348}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.product module}{50}{subsubsection*.349}}
+\newlabel{commands/apidoc/src:module-src.product}{{4.1.1}{50}{src.product module}{subsubsection*.349}{}}
+\newlabel{commands/apidoc/src:src-product-module}{{4.1.1}{50}{src.product module}{subsubsection*.349}{}}
+\newlabel{commands/apidoc/src:src.product.check_config_exists}{{4.1.1}{50}{src.product module}{section*.350}{}}
+\newlabel{commands/apidoc/src:src.product.check_installation}{{4.1.1}{51}{src.product module}{section*.351}{}}
+\newlabel{commands/apidoc/src:src.product.check_source}{{4.1.1}{51}{src.product module}{section*.352}{}}
+\newlabel{commands/apidoc/src:src.product.get_base_install_dir}{{4.1.1}{51}{src.product module}{section*.353}{}}
+\newlabel{commands/apidoc/src:src.product.get_install_dir}{{4.1.1}{51}{src.product module}{section*.354}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_components}{{4.1.1}{51}{src.product module}{section*.355}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_config}{{4.1.1}{52}{src.product module}{section*.356}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_dependencies}{{4.1.1}{52}{src.product module}{section*.357}{}}
+\newlabel{commands/apidoc/src:src.product.get_product_section}{{4.1.1}{52}{src.product module}{section*.358}{}}
+\newlabel{commands/apidoc/src:src.product.get_products_infos}{{4.1.1}{52}{src.product module}{section*.359}{}}
+\newlabel{commands/apidoc/src:src.product.product_compiles}{{4.1.1}{52}{src.product module}{section*.360}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_env_script}{{4.1.1}{52}{src.product module}{section*.361}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_logo}{{4.1.1}{53}{src.product module}{section*.362}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_patches}{{4.1.1}{53}{src.product module}{section*.363}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_salome_gui}{{4.1.1}{53}{src.product module}{section*.364}{}}
+\newlabel{commands/apidoc/src:src.product.product_has_script}{{4.1.1}{53}{src.product module}{section*.365}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_autotools}{{4.1.1}{53}{src.product module}{section*.366}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_cmake}{{4.1.1}{53}{src.product module}{section*.367}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_cpp}{{4.1.1}{53}{src.product module}{section*.368}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_debug}{{4.1.1}{53}{src.product module}{section*.369}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_dev}{{4.1.1}{54}{src.product module}{section*.370}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_fixed}{{4.1.1}{54}{src.product module}{section*.371}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_generated}{{4.1.1}{54}{src.product module}{section*.372}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_mpi}{{4.1.1}{54}{src.product module}{section*.373}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_native}{{4.1.1}{54}{src.product module}{section*.374}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_salome}{{4.1.1}{54}{src.product module}{section*.375}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_smesh_plugin}{{4.1.1}{54}{src.product module}{section*.376}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_vcs}{{4.1.1}{54}{src.product module}{section*.377}{}}
+\newlabel{commands/apidoc/src:src.product.product_is_verbose}{{4.1.1}{54}{src.product module}{section*.378}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.pyconf module}{55}{subsubsection*.379}}
+\newlabel{commands/apidoc/src:src-pyconf-module}{{4.1.1}{55}{src.pyconf module}{subsubsection*.379}{}}
+\newlabel{commands/apidoc/src:module-src.pyconf}{{4.1.1}{55}{src.pyconf module}{subsubsection*.379}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config}{{4.1.1}{56}{src.pyconf module}{section*.380}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.Namespace}{{4.1.1}{56}{src.pyconf module}{section*.381}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.addNamespace}{{4.1.1}{56}{src.pyconf module}{section*.382}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.getByPath}{{4.1.1}{56}{src.pyconf module}{section*.383}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.load}{{4.1.1}{56}{src.pyconf module}{section*.384}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Config.removeNamespace}{{4.1.1}{56}{src.pyconf module}{section*.385}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigError}{{4.1.1}{56}{src.pyconf module}{section*.386}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigFormatError}{{4.1.1}{56}{src.pyconf module}{section*.387}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream}{{4.1.1}{56}{src.pyconf module}{section*.388}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{56}{src.pyconf module}{section*.389}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{56}{src.pyconf module}{section*.390}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{56}{src.pyconf module}{section*.391}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigList}{{4.1.1}{56}{src.pyconf module}{section*.392}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{56}{src.pyconf module}{section*.393}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger}{{4.1.1}{57}{src.pyconf module}{section*.394}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{57}{src.pyconf module}{section*.395}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{57}{src.pyconf module}{section*.396}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{57}{src.pyconf module}{section*.397}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{57}{src.pyconf module}{section*.398}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{57}{src.pyconf module}{section*.399}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream}{{4.1.1}{57}{src.pyconf module}{section*.400}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{57}{src.pyconf module}{section*.401}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{57}{src.pyconf module}{section*.402}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{57}{src.pyconf module}{section*.403}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader}{{4.1.1}{57}{src.pyconf module}{section*.404}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{57}{src.pyconf module}{section*.405}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{57}{src.pyconf module}{section*.406}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.load}{{4.1.1}{58}{src.pyconf module}{section*.407}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.location}{{4.1.1}{58}{src.pyconf module}{section*.408}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.match}{{4.1.1}{58}{src.pyconf module}{section*.409}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{58}{src.pyconf module}{section*.410}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{58}{src.pyconf module}{section*.411}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{58}{src.pyconf module}{section*.412}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{58}{src.pyconf module}{section*.413}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{58}{src.pyconf module}{section*.414}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{58}{src.pyconf module}{section*.415}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{58}{src.pyconf module}{section*.416}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{59}{src.pyconf module}{section*.417}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{59}{src.pyconf module}{section*.418}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{59}{src.pyconf module}{section*.419}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{59}{src.pyconf module}{section*.420}{}}
+\newlabel{commands/apidoc/src:src.pyconf.ConfigResolutionError}{{4.1.1}{59}{src.pyconf module}{section*.421}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container}{{4.1.1}{59}{src.pyconf module}{section*.422}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.evaluate}{{4.1.1}{59}{src.pyconf module}{section*.423}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.setPath}{{4.1.1}{59}{src.pyconf module}{section*.424}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.writeToStream}{{4.1.1}{59}{src.pyconf module}{section*.425}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Container.writeValue}{{4.1.1}{59}{src.pyconf module}{section*.426}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Expression}{{4.1.1}{59}{src.pyconf module}{section*.427}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Expression.evaluate}{{4.1.1}{60}{src.pyconf module}{section*.428}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping}{{4.1.1}{60}{src.pyconf module}{section*.429}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.addMapping}{{4.1.1}{60}{src.pyconf module}{section*.430}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.get}{{4.1.1}{60}{src.pyconf module}{section*.431}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.iteritems}{{4.1.1}{60}{src.pyconf module}{section*.432}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{60}{src.pyconf module}{section*.433}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.keys}{{4.1.1}{60}{src.pyconf module}{section*.434}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{60}{src.pyconf module}{section*.435}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference}{{4.1.1}{60}{src.pyconf module}{section*.436}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.addElement}{{4.1.1}{60}{src.pyconf module}{section*.437}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.findConfig}{{4.1.1}{60}{src.pyconf module}{section*.438}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Reference.resolve}{{4.1.1}{60}{src.pyconf module}{section*.439}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence}{{4.1.1}{60}{src.pyconf module}{section*.440}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{61}{src.pyconf module}{section*.441}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{61}{src.pyconf module}{section*.442}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.append}{{4.1.1}{61}{src.pyconf module}{section*.443}{}}
+\newlabel{commands/apidoc/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{61}{src.pyconf module}{section*.444}{}}
+\newlabel{commands/apidoc/src:src.pyconf.deepCopyMapping}{{4.1.1}{61}{src.pyconf module}{section*.445}{}}
+\newlabel{commands/apidoc/src:src.pyconf.defaultMergeResolve}{{4.1.1}{61}{src.pyconf module}{section*.446}{}}
+\newlabel{commands/apidoc/src:src.pyconf.defaultStreamOpener}{{4.1.1}{61}{src.pyconf module}{section*.447}{}}
+\newlabel{commands/apidoc/src:src.pyconf.isWord}{{4.1.1}{61}{src.pyconf module}{section*.448}{}}
+\newlabel{commands/apidoc/src:src.pyconf.makePath}{{4.1.1}{61}{src.pyconf module}{section*.449}{}}
+\newlabel{commands/apidoc/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{62}{src.pyconf module}{section*.450}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.system module}{62}{subsubsection*.451}}
+\newlabel{commands/apidoc/src:src-system-module}{{4.1.1}{62}{src.system module}{subsubsection*.451}{}}
+\newlabel{commands/apidoc/src:module-src.system}{{4.1.1}{62}{src.system module}{subsubsection*.451}{}}
+\newlabel{commands/apidoc/src:src.system.archive_extract}{{4.1.1}{62}{src.system module}{section*.452}{}}
+\newlabel{commands/apidoc/src:src.system.cvs_extract}{{4.1.1}{62}{src.system module}{section*.453}{}}
+\newlabel{commands/apidoc/src:src.system.git_extract}{{4.1.1}{62}{src.system module}{section*.454}{}}
+\newlabel{commands/apidoc/src:src.system.show_in_editor}{{4.1.1}{63}{src.system module}{section*.455}{}}
+\newlabel{commands/apidoc/src:src.system.svn_extract}{{4.1.1}{63}{src.system module}{section*.456}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.template module}{63}{subsubsection*.457}}
+\newlabel{commands/apidoc/src:module-src.template}{{4.1.1}{63}{src.template module}{subsubsection*.457}{}}
+\newlabel{commands/apidoc/src:src-template-module}{{4.1.1}{63}{src.template module}{subsubsection*.457}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate}{{4.1.1}{63}{src.template module}{section*.458}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate.delimiter}{{4.1.1}{63}{src.template module}{section*.459}{}}
+\newlabel{commands/apidoc/src:src.template.MyTemplate.pattern}{{4.1.1}{63}{src.template module}{section*.460}{}}
+\newlabel{commands/apidoc/src:src.template.substitute}{{4.1.1}{63}{src.template module}{section*.461}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.test\_module module}{63}{subsubsection*.462}}
+\newlabel{commands/apidoc/src:module-src.test_module}{{4.1.1}{63}{src.test\_module module}{subsubsection*.462}{}}
+\newlabel{commands/apidoc/src:src-test-module-module}{{4.1.1}{63}{src.test\_module module}{subsubsection*.462}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test}{{4.1.1}{63}{src.test\_module module}{section*.463}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{63}{src.test\_module module}{section*.464}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.generate_script}{{4.1.1}{63}{src.test\_module module}{section*.465}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.get_test_timeout}{{4.1.1}{63}{src.test\_module module}{section*.466}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{63}{src.test\_module module}{section*.467}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase}{{4.1.1}{63}{src.test\_module module}{section*.468}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{64}{src.test\_module module}{section*.469}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{64}{src.test\_module module}{section*.470}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{64}{src.test\_module module}{section*.471}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.read_results}{{4.1.1}{64}{src.test\_module module}{section*.472}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_all_tests}{{4.1.1}{64}{src.test\_module module}{section*.473}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_grid_tests}{{4.1.1}{64}{src.test\_module module}{section*.474}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_script}{{4.1.1}{64}{src.test\_module module}{section*.475}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_session_tests}{{4.1.1}{64}{src.test\_module module}{section*.476}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{64}{src.test\_module module}{section*.477}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.run_tests}{{4.1.1}{64}{src.test\_module module}{section*.478}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.search_known_errors}{{4.1.1}{64}{src.test\_module module}{section*.479}{}}
+\newlabel{commands/apidoc/src:src.test_module.Test.write_test_margin}{{4.1.1}{64}{src.test\_module module}{section*.480}{}}
+\newlabel{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{64}{src.test\_module module}{section*.481}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.xmlManager module}{64}{subsubsection*.482}}
+\newlabel{commands/apidoc/src:src-xmlmanager-module}{{4.1.1}{64}{src.xmlManager module}{subsubsection*.482}{}}
+\newlabel{commands/apidoc/src:module-src.xmlManager}{{4.1.1}{64}{src.xmlManager module}{subsubsection*.482}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile}{{4.1.1}{64}{src.xmlManager module}{section*.483}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{64}{src.xmlManager module}{section*.484}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{64}{src.xmlManager module}{section*.485}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{64}{src.xmlManager module}{section*.486}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile}{{4.1.1}{64}{src.xmlManager module}{section*.487}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{64}{src.xmlManager module}{section*.488}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{65}{src.xmlManager module}{section*.489}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{65}{src.xmlManager module}{section*.490}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{65}{src.xmlManager module}{section*.491}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.add_simple_node}{{4.1.1}{65}{src.xmlManager module}{section*.492}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.append_node_attrib}{{4.1.1}{65}{src.xmlManager module}{section*.493}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{65}{src.xmlManager module}{section*.494}{}}
+\newlabel{commands/apidoc/src:src.xmlManager.write_report}{{4.1.1}{65}{src.xmlManager module}{section*.495}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Module contents}{66}{subsubsection*.496}}
+\newlabel{commands/apidoc/src:module-src}{{4.1.1}{66}{Module contents}{subsubsection*.496}{}}
+\newlabel{commands/apidoc/src:module-contents}{{4.1.1}{66}{Module contents}{subsubsection*.496}{}}
+\newlabel{commands/apidoc/src:src.Path}{{4.1.1}{66}{Module contents}{section*.497}{}}
+\newlabel{commands/apidoc/src:src.Path.base}{{4.1.1}{66}{Module contents}{section*.498}{}}
+\newlabel{commands/apidoc/src:src.Path.chmod}{{4.1.1}{66}{Module contents}{section*.499}{}}
+\newlabel{commands/apidoc/src:src.Path.copy}{{4.1.1}{66}{Module contents}{section*.500}{}}
+\newlabel{commands/apidoc/src:src.Path.copydir}{{4.1.1}{66}{Module contents}{section*.501}{}}
+\newlabel{commands/apidoc/src:src.Path.copyfile}{{4.1.1}{66}{Module contents}{section*.502}{}}
+\newlabel{commands/apidoc/src:src.Path.copylink}{{4.1.1}{66}{Module contents}{section*.503}{}}
+\newlabel{commands/apidoc/src:src.Path.dir}{{4.1.1}{66}{Module contents}{section*.504}{}}
+\newlabel{commands/apidoc/src:src.Path.exists}{{4.1.1}{66}{Module contents}{section*.505}{}}
+\newlabel{commands/apidoc/src:src.Path.isdir}{{4.1.1}{66}{Module contents}{section*.506}{}}
+\newlabel{commands/apidoc/src:src.Path.isfile}{{4.1.1}{66}{Module contents}{section*.507}{}}
+\newlabel{commands/apidoc/src:src.Path.islink}{{4.1.1}{66}{Module contents}{section*.508}{}}
+\newlabel{commands/apidoc/src:src.Path.list}{{4.1.1}{66}{Module contents}{section*.509}{}}
+\newlabel{commands/apidoc/src:src.Path.make}{{4.1.1}{66}{Module contents}{section*.510}{}}
+\newlabel{commands/apidoc/src:src.Path.readlink}{{4.1.1}{66}{Module contents}{section*.511}{}}
+\newlabel{commands/apidoc/src:src.Path.rm}{{4.1.1}{66}{Module contents}{section*.512}{}}
+\newlabel{commands/apidoc/src:src.Path.smartcopy}{{4.1.1}{66}{Module contents}{section*.513}{}}
+\newlabel{commands/apidoc/src:src.Path.symlink}{{4.1.1}{66}{Module contents}{section*.514}{}}
+\newlabel{commands/apidoc/src:src.SatException}{{4.1.1}{66}{Module contents}{section*.515}{}}
+\newlabel{commands/apidoc/src:src.activate_mesa_property}{{4.1.1}{66}{Module contents}{section*.516}{}}
+\newlabel{commands/apidoc/src:src.check_config_has_application}{{4.1.1}{66}{Module contents}{section*.517}{}}
+\newlabel{commands/apidoc/src:src.check_config_has_profile}{{4.1.1}{66}{Module contents}{section*.518}{}}
+\newlabel{commands/apidoc/src:src.config_has_application}{{4.1.1}{66}{Module contents}{section*.519}{}}
+\newlabel{commands/apidoc/src:src.deepcopy_list}{{4.1.1}{66}{Module contents}{section*.520}{}}
+\newlabel{commands/apidoc/src:src.ensure_path_exists}{{4.1.1}{67}{Module contents}{section*.521}{}}
+\newlabel{commands/apidoc/src:src.find_file_in_lpath}{{4.1.1}{67}{Module contents}{section*.522}{}}
+\newlabel{commands/apidoc/src:src.get_base_path}{{4.1.1}{67}{Module contents}{section*.523}{}}
+\newlabel{commands/apidoc/src:src.get_cfg_param}{{4.1.1}{67}{Module contents}{section*.524}{}}
+\newlabel{commands/apidoc/src:src.get_launcher_name}{{4.1.1}{67}{Module contents}{section*.525}{}}
+\newlabel{commands/apidoc/src:src.get_log_path}{{4.1.1}{67}{Module contents}{section*.526}{}}
+\newlabel{commands/apidoc/src:src.get_property_in_product_cfg}{{4.1.1}{67}{Module contents}{section*.527}{}}
+\newlabel{commands/apidoc/src:src.get_salome_version}{{4.1.1}{67}{Module contents}{section*.528}{}}
+\newlabel{commands/apidoc/src:src.get_tmp_filename}{{4.1.1}{67}{Module contents}{section*.529}{}}
+\newlabel{commands/apidoc/src:src.handleRemoveReadonly}{{4.1.1}{68}{Module contents}{section*.530}{}}
+\newlabel{commands/apidoc/src:src.merge_dicts}{{4.1.1}{68}{Module contents}{section*.531}{}}
+\newlabel{commands/apidoc/src:src.only_numbers}{{4.1.1}{68}{Module contents}{section*.532}{}}
+\newlabel{commands/apidoc/src:src.parse_date}{{4.1.1}{68}{Module contents}{section*.533}{}}
+\newlabel{commands/apidoc/src:src.print_info}{{4.1.1}{68}{Module contents}{section*.534}{}}
+\newlabel{commands/apidoc/src:src.read_config_from_a_file}{{4.1.1}{68}{Module contents}{section*.535}{}}
+\newlabel{commands/apidoc/src:src.remove_item_from_list}{{4.1.1}{68}{Module contents}{section*.536}{}}
+\newlabel{commands/apidoc/src:src.replace_in_file}{{4.1.1}{68}{Module contents}{section*.537}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Release Notes}{69}{chapter.5}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\@writefile{toc}{\contentsline {section}{\numberline {5.1}Release notes}{69}{section.5.1}}
\newlabel{release_notes/release_notes_5.0.0:release-notes}{{5.1}{69}{Release notes}{section.5.1}{}}
\newlabel{release_notes/release_notes_5.0.0::doc}{{5.1}{69}{Release notes}{section.5.1}{}}
-\@writefile{toc}{\contentsline {chapter}{Python Module Index}{71}{section*.532}}
-\@writefile{toc}{\contentsline {chapter}{Index}{73}{section*.533}}
+\@writefile{toc}{\contentsline {chapter}{Python Module Index}{71}{section*.538}}
+\@writefile{toc}{\contentsline {chapter}{Index}{73}{section*.539}}
# Fdb version 3
-["makeindex salomeTools.idx"] 1524653369 "salomeTools.idx" "salomeTools.ind" "salomeTools" 1524653371
- "salomeTools.idx" 1524653371 37218 47758ed2f5c8639f0fe54efc5cfe25d0 ""
+["makeindex salomeTools.idx"] 1529399663 "salomeTools.idx" "salomeTools.ind" "salomeTools" 1529399664
+ "salomeTools.idx" 1529399664 37104 8cdae70614af35a45ec651ac7636acdf ""
(generated)
"salomeTools.ind"
"salomeTools.ilg"
-["pdflatex"] 1524653370 "salomeTools.tex" "salomeTools.pdf" "salomeTools" 1524653371
+["pdflatex"] 1529399663 "salomeTools.tex" "salomeTools.pdf" "salomeTools" 1529399664
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc" 1480098666 4850 80dc9bab7f31fb78a000ccfed0e27cab ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map" 1511824771 3332 103109f5612ad95229751940c61aada0 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm" 1480098688 1268 8067e4f35cbae42c0f58b48da75bf496 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty" 1498861448 10663 d7fcc0dc4f35e8998b8cfeef8407d37d ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty" 1480098827 45360 a0833d32f1b541964596b02870342d5a ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty" 1480098828 6749 16d2656a1984957e674b149555f1ea1d ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty" 1480098828 19488 fdd52eb173b3197d748e1ec25acb042f ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty" 1480098829 22449 7ec15c16d0d66790f28e90343c5434a3 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty" 1480098829 40502 e003406220954b0716679d7928aedd8a ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg" 1480098830 1213 620bba36b25224fa9b7e1ccb4ecb76fd ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty" 1480098837 857 6c716f26c5eadfb81029fcd6ce2d45e6 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd" 1480098837 643 92c451bb86386a4e36a174603ddb5a13 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd" 1480098837 619 96f56dc5d1ef1fe1121f1cfeec70ee0c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty" 1480098840 13791 8c83287d79183c3bf58fd70871e8a70b ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty" 1480098841 37387 afa86533e532701faf233f3f592c61e0 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty" 1485129666 12396 d41f82b039f900e95f351e54ae740f31 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty" 1480098841 12083 80916157594a8e4354985aaefae4f367 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map" 1523607852 2700841 1bc9624fdc91e264bac08ef05942a34b ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt" 1523607929 4139413 5fd665779d626eb6c28594ed7061af12 ""
"/data/tmplgls/wambeke/share/texlive/2017/texmf.cnf" 1523607755 455 5b996dcaa0eb4ef14a83b026bc0a008c ""
- "footnotehyper-sphinx.sty" 1524638079 8886 0562fcad2b7e25f93331edc6fc422c87 ""
- "salomeTools.aux" 1524653371 106073 2b781281a6d65424fa361090a2e9f8d0 ""
- "salomeTools.ind" 1524653369 36465 aadaf8846c67437e6589571999e85f92 "makeindex salomeTools.idx"
- "salomeTools.out" 1524653371 2961 322546514f02df4090c0b702dc220115 ""
- "salomeTools.tex" 1524653368 338658 83495bb642018093f0319dce6d65ae53 ""
- "salomeTools.toc" 1524653371 9038 c339204d39ab9495bf6ec9c1f8815576 ""
- "sat_about.png" 1524487606 282130 625d3edc0de2910af30fe6407ab411b3 ""
- "sphinx.sty" 1524638079 67712 9b578972569f0169bf44cfae88da82f2 ""
- "sphinxhighlight.sty" 1524653367 8137 b8d4ef963833564f6e4eadc09cd757c4 ""
- "sphinxmanual.cls" 1524638079 3589 0b0aac49c6f36925cf5f9d524a75a978 ""
- "sphinxmulticell.sty" 1524638079 14618 0defbdc8536ad2e67f1eac6a1431bc55 ""
+ "fncychap.sty" 1529391879 18775 568efa3fda85869a241e0645298bc277 ""
+ "footnotehyper-sphinx.sty" 1529391879 8886 0562fcad2b7e25f93331edc6fc422c87 ""
+ "salomeTools.aux" 1529399664 85410 654dbf7899c0e0925cdcb2a9b9cb605c ""
+ "salomeTools.ind" 1529399663 36333 3ec0eb65d8a4f28041fe8604ea800ae5 "makeindex salomeTools.idx"
+ "salomeTools.out" 1529399664 3075 c17a5699956f0a7fe0d4242598ffb5fe ""
+ "salomeTools.tex" 1529399660 340746 929605c29e2adbb99b99a777732584f9 ""
+ "salomeTools.toc" 1529399664 8577 0838da642cd6f892734f1aa0cf8141cf ""
+ "sat_about.png" 1529391879 282130 625d3edc0de2910af30fe6407ab411b3 ""
+ "sphinx.sty" 1529391879 67712 9b578972569f0169bf44cfae88da82f2 ""
+ "sphinxhighlight.sty" 1529399659 8137 b8d4ef963833564f6e4eadc09cd757c4 ""
+ "sphinxmanual.cls" 1529391879 3589 0b0aac49c6f36925cf5f9d524a75a978 ""
+ "sphinxmulticell.sty" 1529391879 14618 0defbdc8536ad2e67f1eac6a1431bc55 ""
+ "tabulary.sty" 1529391879 13836 e4c420176570c694fb8cb70f63c46263 ""
(generated)
"salomeTools.aux"
"salomeTools.out"
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty
+INPUT fncychap.sty
+INPUT fncychap.sty
INPUT sphinx.sty
INPUT sphinx.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty
+INPUT tabulary.sty
+INPUT tabulary.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty
INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty
-\indexentry{src.\_\_init\_\_ (module)|hyperpage}{29}
-\indexentry{Path (class in src.\_\_init\_\_)|hyperpage}{29}
-\indexentry{base() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{chmod() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{copy() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{copydir() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{copyfile() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{copylink() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{dir() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{exists() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{isdir() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{isfile() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{islink() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{list() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{make() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{readlink() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{rm() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{smartcopy() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{symlink() (src.\_\_init\_\_.Path method)|hyperpage}{29}
-\indexentry{SatException|hyperpage}{29}
-\indexentry{activate\_mesa\_property() (in module src.\_\_init\_\_)|hyperpage}{29}
-\indexentry{check\_config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{29}
-\indexentry{check\_config\_has\_profile() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{deepcopy\_list() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{ensure\_path\_exists() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{find\_file\_in\_lpath() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{get\_base\_path() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{get\_cfg\_param() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{get\_launcher\_name() (in module src.\_\_init\_\_)|hyperpage}{30}
-\indexentry{get\_log\_path() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{get\_salome\_version() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{get\_tmp\_filename() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{handleRemoveReadonly() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{merge\_dicts() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{only\_numbers() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{parse\_date() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{print\_info() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{remove\_item\_from\_list() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{replace\_in\_file() (in module src.\_\_init\_\_)|hyperpage}{31}
-\indexentry{src.ElementTree (module)|hyperpage}{31}
-\indexentry{Comment() (in module src.ElementTree)|hyperpage}{31}
-\indexentry{dump() (in module src.ElementTree)|hyperpage}{31}
-\indexentry{Element() (in module src.ElementTree)|hyperpage}{31}
-\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{31}
-\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{31}
-\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{31}
-\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{32}
-\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{32}
-\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{32}
-\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{32}
-\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{32}
-\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{iselement() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{iterparse (class in src.ElementTree)|hyperpage}{32}
-\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{32}
-\indexentry{parse() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{PI() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{QName (class in src.ElementTree)|hyperpage}{32}
-\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{tostring() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{32}
-\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{32}
-\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{32}
-\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{32}
-\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{32}
-\indexentry{XML() (in module src.ElementTree)|hyperpage}{32}
-\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{32}
-\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32}
-\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32}
-\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32}
-\indexentry{src.architecture (module)|hyperpage}{32}
-\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{32}
-\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{32}
-\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{33}
-\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{33}
-\indexentry{get\_user() (in module src.architecture)|hyperpage}{33}
-\indexentry{is\_windows() (in module src.architecture)|hyperpage}{33}
-\indexentry{src.compilation (module)|hyperpage}{33}
-\indexentry{Builder (class in src.compilation)|hyperpage}{33}
-\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{check() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{configure() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{install() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{log() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{make() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{33}
-\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{34}
-\indexentry{src.debug (module)|hyperpage}{34}
-\indexentry{InStream (class in src.debug)|hyperpage}{34}
-\indexentry{OutStream (class in src.debug)|hyperpage}{34}
-\indexentry{close() (src.debug.OutStream method)|hyperpage}{34}
-\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{34}
-\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{34}
-\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{34}
-\indexentry{indent() (in module src.debug)|hyperpage}{34}
-\indexentry{pop\_debug() (in module src.debug)|hyperpage}{34}
-\indexentry{push\_debug() (in module src.debug)|hyperpage}{34}
-\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{34}
-\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{34}
-\indexentry{tofix() (in module src.debug)|hyperpage}{35}
-\indexentry{write() (in module src.debug)|hyperpage}{35}
-\indexentry{src.environment (module)|hyperpage}{35}
-\indexentry{Environ (class in src.environment)|hyperpage}{35}
-\indexentry{append() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{get() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{prepend() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{35}
-\indexentry{set() (src.environment.Environ method)|hyperpage}{36}
-\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{36}
-\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{36}
-\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{36}
-\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{36}
-\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{36}
-\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{36}
-\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{36}
-\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{36}
-\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{37}
-\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{38}
-\indexentry{Shell (class in src.environment)|hyperpage}{38}
-\indexentry{load\_environment() (in module src.environment)|hyperpage}{38}
-\indexentry{src.fileEnviron (module)|hyperpage}{39}
-\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{39}
-\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39}
-\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39}
-\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39}
-\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{39}
-\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39}
-\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39}
-\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39}
-\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39}
-\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39}
-\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{39}
-\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40}
-\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{40}
-\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{40}
-\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{41}
-\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
-\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
-\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{42}
-\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42}
-\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
-\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{43}
-\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43}
-\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43}
-\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43}
-\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43}
-\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44}
-\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{44}
-\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{44}
-\indexentry{src.fork (module)|hyperpage}{45}
-\indexentry{batch() (in module src.fork)|hyperpage}{45}
-\indexentry{batch\_salome() (in module src.fork)|hyperpage}{45}
-\indexentry{launch\_command() (in module src.fork)|hyperpage}{45}
-\indexentry{show\_progress() (in module src.fork)|hyperpage}{45}
-\indexentry{write\_back() (in module src.fork)|hyperpage}{45}
-\indexentry{src.logger (module)|hyperpage}{45}
-\indexentry{Logger (class in src.logger)|hyperpage}{45}
-\indexentry{add\_link() (src.logger.Logger method)|hyperpage}{45}
-\indexentry{end\_write() (src.logger.Logger method)|hyperpage}{45}
-\indexentry{error() (src.logger.Logger method)|hyperpage}{45}
-\indexentry{flush() (src.logger.Logger method)|hyperpage}{45}
-\indexentry{put\_initial\_xml\_fields() (src.logger.Logger method)|hyperpage}{46}
-\indexentry{write() (src.logger.Logger method)|hyperpage}{46}
-\indexentry{date\_to\_datetime() (in module src.logger)|hyperpage}{46}
-\indexentry{list\_log\_file() (in module src.logger)|hyperpage}{46}
-\indexentry{show\_command\_log() (in module src.logger)|hyperpage}{46}
-\indexentry{timedelta\_total\_seconds() (in module src.logger)|hyperpage}{46}
-\indexentry{update\_hat\_xml() (in module src.logger)|hyperpage}{46}
-\indexentry{src.options (module)|hyperpage}{47}
-\indexentry{OptResult (class in src.options)|hyperpage}{47}
-\indexentry{Options (class in src.options)|hyperpage}{47}
-\indexentry{add\_option() (src.options.Options method)|hyperpage}{47}
-\indexentry{parse\_args() (src.options.Options method)|hyperpage}{47}
-\indexentry{print\_help() (src.options.Options method)|hyperpage}{47}
-\indexentry{src.printcolors (module)|hyperpage}{47}
-\indexentry{cleancolor() (in module src.printcolors)|hyperpage}{47}
-\indexentry{print\_color\_map() (in module src.printcolors)|hyperpage}{47}
-\indexentry{print\_color\_range() (in module src.printcolors)|hyperpage}{48}
-\indexentry{print\_value() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printc() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printcError() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printcHeader() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printcHighlight() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printcInfo() (in module src.printcolors)|hyperpage}{48}
-\indexentry{printcLabel() (in module src.printcolors)|hyperpage}{49}
-\indexentry{printcSuccess() (in module src.printcolors)|hyperpage}{49}
-\indexentry{printcWarning() (in module src.printcolors)|hyperpage}{49}
-\indexentry{src.product (module)|hyperpage}{49}
-\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{49}
-\indexentry{check\_installation() (in module src.product)|hyperpage}{49}
-\indexentry{check\_source() (in module src.product)|hyperpage}{49}
-\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{49}
-\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{50}
-\indexentry{get\_product\_components() (in module src.product)|hyperpage}{50}
-\indexentry{get\_product\_config() (in module src.product)|hyperpage}{50}
-\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{50}
-\indexentry{get\_product\_section() (in module src.product)|hyperpage}{50}
-\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{51}
-\indexentry{product\_compiles() (in module src.product)|hyperpage}{51}
-\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{51}
-\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{51}
-\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{51}
-\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{51}
-\indexentry{product\_has\_script() (in module src.product)|hyperpage}{51}
-\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{51}
-\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_native() (in module src.product)|hyperpage}{52}
-\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{53}
-\indexentry{product\_is\_sample() (in module src.product)|hyperpage}{53}
-\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{53}
-\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{53}
-\indexentry{src.pyconf (module)|hyperpage}{53}
-\indexentry{Config (class in src.pyconf)|hyperpage}{54}
-\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{54}
-\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{54}
-\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{54}
-\indexentry{load() (src.pyconf.Config method)|hyperpage}{54}
-\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{55}
-\indexentry{ConfigError|hyperpage}{55}
-\indexentry{ConfigFormatError|hyperpage}{55}
-\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{55}
-\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{55}
-\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{55}
-\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{55}
-\indexentry{ConfigList (class in src.pyconf)|hyperpage}{55}
-\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{55}
-\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{55}
-\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{55}
-\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{55}
-\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{55}
-\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{56}
-\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{56}
-\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{56}
-\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{56}
-\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{56}
-\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{56}
-\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{56}
-\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{56}
-\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{57}
-\indexentry{ConfigResolutionError|hyperpage}{57}
-\indexentry{Container (class in src.pyconf)|hyperpage}{57}
-\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{58}
-\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{58}
-\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{58}
-\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{58}
-\indexentry{Expression (class in src.pyconf)|hyperpage}{58}
-\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{58}
-\indexentry{Mapping (class in src.pyconf)|hyperpage}{58}
-\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{58}
-\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{58}
-\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{58}
-\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{58}
-\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{58}
-\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{59}
-\indexentry{Reference (class in src.pyconf)|hyperpage}{59}
-\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{59}
-\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{59}
-\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{59}
-\indexentry{Sequence (class in src.pyconf)|hyperpage}{59}
-\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{59}
-\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{59}
-\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{59}
-\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{59}
-\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{59}
-\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{59}
-\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{60}
-\indexentry{isWord() (in module src.pyconf)|hyperpage}{60}
-\indexentry{makePath() (in module src.pyconf)|hyperpage}{60}
-\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{60}
-\indexentry{src.system (module)|hyperpage}{60}
-\indexentry{archive\_extract() (in module src.system)|hyperpage}{60}
-\indexentry{cvs\_extract() (in module src.system)|hyperpage}{60}
-\indexentry{git\_extract() (in module src.system)|hyperpage}{61}
-\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{61}
-\indexentry{svn\_extract() (in module src.system)|hyperpage}{61}
-\indexentry{src.template (module)|hyperpage}{62}
-\indexentry{MyTemplate (class in src.template)|hyperpage}{62}
-\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{62}
-\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{62}
-\indexentry{substitute() (in module src.template)|hyperpage}{62}
-\indexentry{src.test\_module (module)|hyperpage}{62}
-\indexentry{Test (class in src.test\_module)|hyperpage}{62}
-\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{62}
-\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{62}
-\indexentry{src.xmlManager (module)|hyperpage}{62}
-\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{62}
-\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{62}
-\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{63}
-\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{63}
-\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{63}
-\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{63}
-\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{63}
-\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{63}
-\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{63}
-\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{63}
-\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{64}
-\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{64}
-\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{64}
-\indexentry{src.colorama (module)|hyperpage}{64}
-\indexentry{src.colorama.ansi (module)|hyperpage}{64}
-\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{64}
-\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64}
-\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65}
-\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{65}
-\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{65}
-\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65}
-\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65}
-\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65}
-\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65}
-\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65}
-\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{65}
-\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65}
-\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{65}
-\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66}
-\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66}
-\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66}
-\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66}
-\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{66}
-\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{66}
-\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{66}
-\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{66}
-\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{66}
-\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{66}
-\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{66}
-\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{66}
-\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66}
-\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{66}
-\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{66}
-\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{66}
-\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{66}
-\indexentry{src.colorama.initialise (module)|hyperpage}{67}
-\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{init() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{67}
-\indexentry{src.colorama.win32 (module)|hyperpage}{67}
-\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{67}
-\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{67}
-\indexentry{src.colorama.winterm (module)|hyperpage}{67}
-\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{67}
-\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{67}
-\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{67}
-\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{67}
-\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{67}
-\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{67}
-\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{67}
-\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{67}
-\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{68}
-\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{68}
-\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{68}
+\indexentry{src.colorama.ansi (module)|hyperpage}{29}
+\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{29}
+\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{29}
+\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{31}
+\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{31}
+\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{31}
+\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{31}
+\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{src.colorama.initialise (module)|hyperpage}{31}
+\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{init() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{src.colorama.win32 (module)|hyperpage}{32}
+\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{32}
+\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{32}
+\indexentry{src.colorama.winterm (module)|hyperpage}{32}
+\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{src.colorama (module)|hyperpage}{33}
+\indexentry{src.ElementTree (module)|hyperpage}{33}
+\indexentry{Comment() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{dump() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{Element() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{33}
+\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{33}
+\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{iselement() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{iterparse (class in src.ElementTree)|hyperpage}{33}
+\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{33}
+\indexentry{parse() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{PI() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{QName (class in src.ElementTree)|hyperpage}{33}
+\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{tostring() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{33}
+\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{33}
+\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{33}
+\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{33}
+\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{33}
+\indexentry{XML() (in module src.ElementTree)|hyperpage}{33}
+\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{33}
+\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{33}
+\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{33}
+\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{33}
+\indexentry{src.architecture (module)|hyperpage}{34}
+\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{34}
+\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{34}
+\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{34}
+\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{34}
+\indexentry{get\_user() (in module src.architecture)|hyperpage}{34}
+\indexentry{is\_windows() (in module src.architecture)|hyperpage}{34}
+\indexentry{src.compilation (module)|hyperpage}{34}
+\indexentry{Builder (class in src.compilation)|hyperpage}{34}
+\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{check() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{configure() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{34}
+\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{install() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{log() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{make() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{35}
+\indexentry{src.debug (module)|hyperpage}{35}
+\indexentry{InStream (class in src.debug)|hyperpage}{35}
+\indexentry{OutStream (class in src.debug)|hyperpage}{35}
+\indexentry{close() (src.debug.OutStream method)|hyperpage}{35}
+\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{35}
+\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{35}
+\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{36}
+\indexentry{indent() (in module src.debug)|hyperpage}{36}
+\indexentry{pop\_debug() (in module src.debug)|hyperpage}{36}
+\indexentry{push\_debug() (in module src.debug)|hyperpage}{36}
+\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{36}
+\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{36}
+\indexentry{tofix() (in module src.debug)|hyperpage}{36}
+\indexentry{write() (in module src.debug)|hyperpage}{36}
+\indexentry{src.environment (module)|hyperpage}{36}
+\indexentry{Environ (class in src.environment)|hyperpage}{36}
+\indexentry{append() (src.environment.Environ method)|hyperpage}{36}
+\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{36}
+\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{36}
+\indexentry{get() (src.environment.Environ method)|hyperpage}{36}
+\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{36}
+\indexentry{prepend() (src.environment.Environ method)|hyperpage}{37}
+\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{37}
+\indexentry{set() (src.environment.Environ method)|hyperpage}{37}
+\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{37}
+\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{37}
+\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{37}
+\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{37}
+\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{37}
+\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{38}
+\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{39}
+\indexentry{Shell (class in src.environment)|hyperpage}{40}
+\indexentry{load\_environment() (in module src.environment)|hyperpage}{40}
+\indexentry{src.fileEnviron (module)|hyperpage}{40}
+\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{40}
+\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{40}
+\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{40}
+\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{40}
+\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{40}
+\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{40}
+\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{40}
+\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{40}
+\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{41}
+\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{41}
+\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{41}
+\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{41}
+\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{42}
+\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{42}
+\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{43}
+\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{43}
+\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{43}
+\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{43}
+\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{43}
+\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43}
+\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{44}
+\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{44}
+\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{45}
+\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{46}
+\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{46}
+\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{46}
+\indexentry{src.fork (module)|hyperpage}{46}
+\indexentry{batch() (in module src.fork)|hyperpage}{46}
+\indexentry{batch\_salome() (in module src.fork)|hyperpage}{46}
+\indexentry{launch\_command() (in module src.fork)|hyperpage}{46}
+\indexentry{show\_progress() (in module src.fork)|hyperpage}{46}
+\indexentry{write\_back() (in module src.fork)|hyperpage}{46}
+\indexentry{src.logger (module)|hyperpage}{46}
+\indexentry{Logger (class in src.logger)|hyperpage}{46}
+\indexentry{add\_link() (src.logger.Logger method)|hyperpage}{46}
+\indexentry{end\_write() (src.logger.Logger method)|hyperpage}{47}
+\indexentry{error() (src.logger.Logger method)|hyperpage}{47}
+\indexentry{flush() (src.logger.Logger method)|hyperpage}{47}
+\indexentry{put\_initial\_xml\_fields() (src.logger.Logger method)|hyperpage}{47}
+\indexentry{write() (src.logger.Logger method)|hyperpage}{47}
+\indexentry{date\_to\_datetime() (in module src.logger)|hyperpage}{47}
+\indexentry{list\_log\_file() (in module src.logger)|hyperpage}{47}
+\indexentry{show\_command\_log() (in module src.logger)|hyperpage}{47}
+\indexentry{timedelta\_total\_seconds() (in module src.logger)|hyperpage}{47}
+\indexentry{update\_hat\_xml() (in module src.logger)|hyperpage}{48}
+\indexentry{src.options (module)|hyperpage}{48}
+\indexentry{OptResult (class in src.options)|hyperpage}{48}
+\indexentry{Options (class in src.options)|hyperpage}{48}
+\indexentry{add\_option() (src.options.Options method)|hyperpage}{48}
+\indexentry{debug\_write() (src.options.Options method)|hyperpage}{48}
+\indexentry{filterLevel() (src.options.Options method)|hyperpage}{48}
+\indexentry{filterList2() (src.options.Options method)|hyperpage}{48}
+\indexentry{getDetailOption() (src.options.Options method)|hyperpage}{48}
+\indexentry{get\_help() (src.options.Options method)|hyperpage}{49}
+\indexentry{indent() (src.options.Options method)|hyperpage}{49}
+\indexentry{parse\_args() (src.options.Options method)|hyperpage}{49}
+\indexentry{print\_help() (src.options.Options method)|hyperpage}{49}
+\indexentry{src.printcolors (module)|hyperpage}{49}
+\indexentry{cleancolor() (in module src.printcolors)|hyperpage}{49}
+\indexentry{print\_color\_map() (in module src.printcolors)|hyperpage}{49}
+\indexentry{print\_color\_range() (in module src.printcolors)|hyperpage}{49}
+\indexentry{print\_value() (in module src.printcolors)|hyperpage}{49}
+\indexentry{printc() (in module src.printcolors)|hyperpage}{49}
+\indexentry{printcError() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcHeader() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcHighlight() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcInfo() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcLabel() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcSuccess() (in module src.printcolors)|hyperpage}{50}
+\indexentry{printcWarning() (in module src.printcolors)|hyperpage}{50}
+\indexentry{src.product (module)|hyperpage}{50}
+\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{50}
+\indexentry{check\_installation() (in module src.product)|hyperpage}{51}
+\indexentry{check\_source() (in module src.product)|hyperpage}{51}
+\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{51}
+\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{51}
+\indexentry{get\_product\_components() (in module src.product)|hyperpage}{51}
+\indexentry{get\_product\_config() (in module src.product)|hyperpage}{52}
+\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{52}
+\indexentry{get\_product\_section() (in module src.product)|hyperpage}{52}
+\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{52}
+\indexentry{product\_compiles() (in module src.product)|hyperpage}{52}
+\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{52}
+\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{53}
+\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{53}
+\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{53}
+\indexentry{product\_has\_script() (in module src.product)|hyperpage}{53}
+\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{53}
+\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{53}
+\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{53}
+\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{53}
+\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_native() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_verbose() (in module src.product)|hyperpage}{54}
+\indexentry{src.pyconf (module)|hyperpage}{55}
+\indexentry{Config (class in src.pyconf)|hyperpage}{56}
+\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{56}
+\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{56}
+\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{56}
+\indexentry{load() (src.pyconf.Config method)|hyperpage}{56}
+\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{56}
+\indexentry{ConfigError|hyperpage}{56}
+\indexentry{ConfigFormatError|hyperpage}{56}
+\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{56}
+\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{56}
+\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{56}
+\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{56}
+\indexentry{ConfigList (class in src.pyconf)|hyperpage}{56}
+\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{56}
+\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{57}
+\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{57}
+\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{57}
+\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{57}
+\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{57}
+\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{57}
+\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{57}
+\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{57}
+\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{ConfigResolutionError|hyperpage}{59}
+\indexentry{Container (class in src.pyconf)|hyperpage}{59}
+\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{59}
+\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{59}
+\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{59}
+\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{59}
+\indexentry{Expression (class in src.pyconf)|hyperpage}{59}
+\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{60}
+\indexentry{Mapping (class in src.pyconf)|hyperpage}{60}
+\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{60}
+\indexentry{Reference (class in src.pyconf)|hyperpage}{60}
+\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{60}
+\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{60}
+\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{60}
+\indexentry{Sequence (class in src.pyconf)|hyperpage}{60}
+\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{61}
+\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{61}
+\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{61}
+\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{61}
+\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{61}
+\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{61}
+\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{61}
+\indexentry{isWord() (in module src.pyconf)|hyperpage}{61}
+\indexentry{makePath() (in module src.pyconf)|hyperpage}{61}
+\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{62}
+\indexentry{src.system (module)|hyperpage}{62}
+\indexentry{archive\_extract() (in module src.system)|hyperpage}{62}
+\indexentry{cvs\_extract() (in module src.system)|hyperpage}{62}
+\indexentry{git\_extract() (in module src.system)|hyperpage}{62}
+\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{63}
+\indexentry{svn\_extract() (in module src.system)|hyperpage}{63}
+\indexentry{src.template (module)|hyperpage}{63}
+\indexentry{MyTemplate (class in src.template)|hyperpage}{63}
+\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{63}
+\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{63}
+\indexentry{substitute() (in module src.template)|hyperpage}{63}
+\indexentry{src.test\_module (module)|hyperpage}{63}
+\indexentry{Test (class in src.test\_module)|hyperpage}{63}
+\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{63}
+\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{63}
+\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{63}
+\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{63}
+\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{63}
+\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{64}
+\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{64}
+\indexentry{src.xmlManager (module)|hyperpage}{64}
+\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{64}
+\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{64}
+\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{64}
+\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{64}
+\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{64}
+\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{64}
+\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{65}
+\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{65}
+\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{65}
+\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{65}
+\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{65}
+\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{65}
+\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{65}
+\indexentry{src (module)|hyperpage}{66}
+\indexentry{Path (class in src)|hyperpage}{66}
+\indexentry{base() (src.Path method)|hyperpage}{66}
+\indexentry{chmod() (src.Path method)|hyperpage}{66}
+\indexentry{copy() (src.Path method)|hyperpage}{66}
+\indexentry{copydir() (src.Path method)|hyperpage}{66}
+\indexentry{copyfile() (src.Path method)|hyperpage}{66}
+\indexentry{copylink() (src.Path method)|hyperpage}{66}
+\indexentry{dir() (src.Path method)|hyperpage}{66}
+\indexentry{exists() (src.Path method)|hyperpage}{66}
+\indexentry{isdir() (src.Path method)|hyperpage}{66}
+\indexentry{isfile() (src.Path method)|hyperpage}{66}
+\indexentry{islink() (src.Path method)|hyperpage}{66}
+\indexentry{list() (src.Path method)|hyperpage}{66}
+\indexentry{make() (src.Path method)|hyperpage}{66}
+\indexentry{readlink() (src.Path method)|hyperpage}{66}
+\indexentry{rm() (src.Path method)|hyperpage}{66}
+\indexentry{smartcopy() (src.Path method)|hyperpage}{66}
+\indexentry{symlink() (src.Path method)|hyperpage}{66}
+\indexentry{SatException|hyperpage}{66}
+\indexentry{activate\_mesa\_property() (in module src)|hyperpage}{66}
+\indexentry{check\_config\_has\_application() (in module src)|hyperpage}{66}
+\indexentry{check\_config\_has\_profile() (in module src)|hyperpage}{66}
+\indexentry{config\_has\_application() (in module src)|hyperpage}{66}
+\indexentry{deepcopy\_list() (in module src)|hyperpage}{66}
+\indexentry{ensure\_path\_exists() (in module src)|hyperpage}{67}
+\indexentry{find\_file\_in\_lpath() (in module src)|hyperpage}{67}
+\indexentry{get\_base\_path() (in module src)|hyperpage}{67}
+\indexentry{get\_cfg\_param() (in module src)|hyperpage}{67}
+\indexentry{get\_launcher\_name() (in module src)|hyperpage}{67}
+\indexentry{get\_log\_path() (in module src)|hyperpage}{67}
+\indexentry{get\_property\_in\_product\_cfg() (in module src)|hyperpage}{67}
+\indexentry{get\_salome\_version() (in module src)|hyperpage}{67}
+\indexentry{get\_tmp\_filename() (in module src)|hyperpage}{67}
+\indexentry{handleRemoveReadonly() (in module src)|hyperpage}{68}
+\indexentry{merge\_dicts() (in module src)|hyperpage}{68}
+\indexentry{only\_numbers() (in module src)|hyperpage}{68}
+\indexentry{parse\_date() (in module src)|hyperpage}{68}
+\indexentry{print\_info() (in module src)|hyperpage}{68}
+\indexentry{read\_config\_from\_a\_file() (in module src)|hyperpage}{68}
+\indexentry{remove\_item\_from\_list() (in module src)|hyperpage}{68}
+\indexentry{replace\_in\_file() (in module src)|hyperpage}{68}
This is makeindex, version 2.15 [TeX Live 2017] (kpathsea + Thai support).
Scanning style file ./python.ist.......done (7 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).
+Scanning input file salomeTools.idx....done (518 entries accepted, 0 rejected).
+Sorting entries.......done (4982 comparisons).
+Generating output file salomeTools.ind....done (590 lines written, 0 warnings).
Output written in salomeTools.ind.
Transcript written in salomeTools.ilg.
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
\bigletter A
- \item activate\_mesa\_property() (in module src.\_\_init\_\_), \hyperpage{29}
- \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{36}
- \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{39}
- \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{40}
- \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{43}
- \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{43}
- \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{36}
- \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{43}
- \item add\_link() (src.logger.Logger method), \hyperpage{45}
- \item add\_option() (src.options.Options method), \hyperpage{47}
- \item add\_simple\_node() (in module src.xmlManager), \hyperpage{63}
- \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{63}
- \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{36}
- \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{43}
- \item addElement() (src.pyconf.Reference method), \hyperpage{59}
- \item addMapping() (src.pyconf.Mapping method), \hyperpage{58}
- \item addNamespace() (src.pyconf.Config method), \hyperpage{54}
- \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{66}
- \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{66}
- \item AnsiBack (class in src.colorama.ansi), \hyperpage{64}
- \item AnsiCodes (class in src.colorama.ansi), \hyperpage{65}
- \item AnsiCursor (class in src.colorama.ansi), \hyperpage{65}
- \item AnsiFore (class in src.colorama.ansi), \hyperpage{65}
- \item AnsiStyle (class in src.colorama.ansi), \hyperpage{65}
- \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{66}
- \item append() (src.environment.Environ method), \hyperpage{35}
- \item append() (src.environment.SalomeEnviron method), \hyperpage{36}
- \item append() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item append() (src.pyconf.Sequence method), \hyperpage{59}
- \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{64}
- \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{63}
- \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{63}
- \item append\_value() (src.environment.Environ method), \hyperpage{35}
- \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item archive\_extract() (in module src.system), \hyperpage{60}
+ \item activate\_mesa\_property() (in module src), \hyperpage{66}
+ \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{37}
+ \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{40}
+ \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item add\_link() (src.logger.Logger method), \hyperpage{46}
+ \item add\_option() (src.options.Options method), \hyperpage{48}
+ \item add\_simple\_node() (in module src.xmlManager), \hyperpage{65}
+ \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{64}
+ \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item addElement() (src.pyconf.Reference method), \hyperpage{60}
+ \item addMapping() (src.pyconf.Mapping method), \hyperpage{60}
+ \item addNamespace() (src.pyconf.Config method), \hyperpage{56}
+ \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{31}
+ \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{31}
+ \item AnsiBack (class in src.colorama.ansi), \hyperpage{29}
+ \item AnsiCodes (class in src.colorama.ansi), \hyperpage{29}
+ \item AnsiCursor (class in src.colorama.ansi), \hyperpage{30}
+ \item AnsiFore (class in src.colorama.ansi), \hyperpage{30}
+ \item AnsiStyle (class in src.colorama.ansi), \hyperpage{30}
+ \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{31}
+ \item append() (src.environment.Environ method), \hyperpage{36}
+ \item append() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item append() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
+ \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item append() (src.pyconf.Sequence method), \hyperpage{61}
+ \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{65}
+ \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{65}
+ \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{65}
+ \item append\_value() (src.environment.Environ method), \hyperpage{36}
+ \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item archive\_extract() (in module src.system), \hyperpage{62}
\indexspace
\bigletter B
- \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item back() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item base() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item BashFileEnviron (class in src.fileEnviron), \hyperpage{39}
- \item batch() (in module src.fork), \hyperpage{45}
- \item batch\_salome() (in module src.fork), \hyperpage{45}
- \item BatFileEnviron (class in src.fileEnviron), \hyperpage{39}
- \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{67}
- \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{67}
- \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66}
- \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{67}
- \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{67}
- \item build\_configure() (src.compilation.Builder method), \hyperpage{33}
- \item Builder (class in src.compilation), \hyperpage{33}
+ \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+ \item back() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item base() (src.Path method), \hyperpage{66}
+ \item BashFileEnviron (class in src.fileEnviron), \hyperpage{40}
+ \item batch() (in module src.fork), \hyperpage{46}
+ \item batch\_salome() (in module src.fork), \hyperpage{46}
+ \item BatFileEnviron (class in src.fileEnviron), \hyperpage{40}
+ \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+ \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+ \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+ \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
+ \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
+ \item build\_configure() (src.compilation.Builder method), \hyperpage{34}
+ \item Builder (class in src.compilation), \hyperpage{34}
\indexspace
\bigletter C
- \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item check() (src.compilation.Builder method), \hyperpage{33}
- \item check\_config\_exists() (in module src.product), \hyperpage{49}
- \item check\_config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{29}
- \item check\_config\_has\_profile() (in module src.\_\_init\_\_), \hyperpage{30}
- \item check\_installation() (in module src.product), \hyperpage{49}
- \item check\_source() (in module src.product), \hyperpage{49}
- \item chmod() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item cleancolor() (in module src.printcolors), \hyperpage{47}
- \item clear\_line() (in module src.colorama.ansi), \hyperpage{66}
- \item clear\_screen() (in module src.colorama.ansi), \hyperpage{66}
- \item close() (src.debug.OutStream method), \hyperpage{34}
- \item close() (src.ElementTree.TreeBuilder method), \hyperpage{32}
- \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32}
- \item close() (src.pyconf.ConfigInputStream method), \hyperpage{55}
- \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{56}
- \item cmake() (src.compilation.Builder method), \hyperpage{33}
- \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{66}
- \item colorama\_text() (in module src.colorama.initialise), \hyperpage{67}
- \item command\_value() (src.environment.Environ method), \hyperpage{35}
- \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{39}
- \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{39}
- \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42}
- \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item Comment() (in module src.ElementTree), \hyperpage{31}
- \item complete\_environment() (src.compilation.Builder method), \hyperpage{33}
- \item Config (class in src.pyconf), \hyperpage{54}
- \item Config.Namespace (class in src.pyconf), \hyperpage{54}
- \item config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{30}
- \item ConfigError, \hyperpage{55}
- \item ConfigFormatError, \hyperpage{55}
- \item ConfigInputStream (class in src.pyconf), \hyperpage{55}
- \item ConfigList (class in src.pyconf), \hyperpage{55}
- \item ConfigMerger (class in src.pyconf), \hyperpage{55}
- \item ConfigOutputStream (class in src.pyconf), \hyperpage{56}
- \item ConfigReader (class in src.pyconf), \hyperpage{56}
- \item ConfigResolutionError, \hyperpage{57}
- \item configure() (src.compilation.Builder method), \hyperpage{33}
- \item Container (class in src.pyconf), \hyperpage{57}
- \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{39}
- \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item copy() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item copydir() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item copyfile() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item copylink() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item cvs\_extract() (in module src.system), \hyperpage{60}
- \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{67}
+ \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item check() (src.compilation.Builder method), \hyperpage{34}
+ \item check\_config\_exists() (in module src.product), \hyperpage{50}
+ \item check\_config\_has\_application() (in module src), \hyperpage{66}
+ \item check\_config\_has\_profile() (in module src), \hyperpage{66}
+ \item check\_installation() (in module src.product), \hyperpage{51}
+ \item check\_source() (in module src.product), \hyperpage{51}
+ \item chmod() (src.Path method), \hyperpage{66}
+ \item cleancolor() (in module src.printcolors), \hyperpage{49}
+ \item clear\_line() (in module src.colorama.ansi), \hyperpage{30}
+ \item clear\_screen() (in module src.colorama.ansi), \hyperpage{30}
+ \item close() (src.debug.OutStream method), \hyperpage{35}
+ \item close() (src.ElementTree.TreeBuilder method), \hyperpage{33}
+ \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{33}
+ \item close() (src.pyconf.ConfigInputStream method), \hyperpage{56}
+ \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{57}
+ \item cmake() (src.compilation.Builder method), \hyperpage{34}
+ \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{30}
+ \item colorama\_text() (in module src.colorama.initialise), \hyperpage{31}
+ \item command\_value() (src.environment.Environ method), \hyperpage{36}
+ \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{40}
+ \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{40}
+ \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item Comment() (in module src.ElementTree), \hyperpage{33}
+ \item complete\_environment() (src.compilation.Builder method), \hyperpage{34}
+ \item Config (class in src.pyconf), \hyperpage{56}
+ \item Config.Namespace (class in src.pyconf), \hyperpage{56}
+ \item config\_has\_application() (in module src), \hyperpage{66}
+ \item ConfigError, \hyperpage{56}
+ \item ConfigFormatError, \hyperpage{56}
+ \item ConfigInputStream (class in src.pyconf), \hyperpage{56}
+ \item ConfigList (class in src.pyconf), \hyperpage{56}
+ \item ConfigMerger (class in src.pyconf), \hyperpage{57}
+ \item ConfigOutputStream (class in src.pyconf), \hyperpage{57}
+ \item ConfigReader (class in src.pyconf), \hyperpage{57}
+ \item ConfigResolutionError, \hyperpage{59}
+ \item configure() (src.compilation.Builder method), \hyperpage{34}
+ \item Container (class in src.pyconf), \hyperpage{59}
+ \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{41}
+ \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item copy() (src.Path method), \hyperpage{66}
+ \item copydir() (src.Path method), \hyperpage{66}
+ \item copyfile() (src.Path method), \hyperpage{66}
+ \item copylink() (src.Path method), \hyperpage{66}
+ \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item cvs\_extract() (in module src.system), \hyperpage{62}
+ \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{32}
\indexspace
\bigletter D
- \item data() (src.ElementTree.TreeBuilder method), \hyperpage{32}
- \item date\_to\_datetime() (in module src.logger), \hyperpage{46}
- \item deepcopy\_list() (in module src.\_\_init\_\_), \hyperpage{30}
- \item deepCopyMapping() (in module src.pyconf), \hyperpage{59}
- \item defaultMergeResolve() (in module src.pyconf), \hyperpage{59}
- \item defaultStreamOpener() (in module src.pyconf), \hyperpage{60}
- \item deinit() (in module src.colorama.initialise), \hyperpage{67}
- \item delimiter (src.template.MyTemplate attribute), \hyperpage{62}
- \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66}
- \item dir() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{33}
- \item do\_default\_build() (src.compilation.Builder method), \hyperpage{33}
- \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{33}
- \item do\_script\_build() (src.compilation.Builder method), \hyperpage{33}
- \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32}
- \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item dump() (in module src.ElementTree), \hyperpage{31}
- \item dump() (src.environment.SalomeEnviron method), \hyperpage{37}
+ \item data() (src.ElementTree.TreeBuilder method), \hyperpage{33}
+ \item date\_to\_datetime() (in module src.logger), \hyperpage{47}
+ \item debug\_write() (src.options.Options method), \hyperpage{48}
+ \item deepcopy\_list() (in module src), \hyperpage{66}
+ \item deepCopyMapping() (in module src.pyconf), \hyperpage{61}
+ \item defaultMergeResolve() (in module src.pyconf), \hyperpage{61}
+ \item defaultStreamOpener() (in module src.pyconf), \hyperpage{61}
+ \item deinit() (in module src.colorama.initialise), \hyperpage{31}
+ \item delimiter (src.template.MyTemplate attribute), \hyperpage{63}
+ \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+ \item dir() (src.Path method), \hyperpage{66}
+ \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{34}
+ \item do\_default\_build() (src.compilation.Builder method), \hyperpage{34}
+ \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{35}
+ \item do\_script\_build() (src.compilation.Builder method), \hyperpage{35}
+ \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{33}
+ \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+ \item dump() (in module src.ElementTree), \hyperpage{33}
+ \item dump() (src.environment.SalomeEnviron method), \hyperpage{38}
\indexspace
\bigletter E
- \item Element() (in module src.ElementTree), \hyperpage{31}
- \item ElementTree (class in src.ElementTree), \hyperpage{31}
- \item end() (src.ElementTree.TreeBuilder method), \hyperpage{32}
- \item end\_write() (src.logger.Logger method), \hyperpage{45}
- \item ensure\_path\_exists() (in module src.\_\_init\_\_), \hyperpage{30}
- \item Environ (class in src.environment), \hyperpage{35}
- \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item error() (src.logger.Logger method), \hyperpage{45}
- \item evaluate() (src.pyconf.Container method), \hyperpage{58}
- \item evaluate() (src.pyconf.Expression method), \hyperpage{58}
- \item exists() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item Expression (class in src.pyconf), \hyperpage{58}
- \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
+ \item Element() (in module src.ElementTree), \hyperpage{33}
+ \item ElementTree (class in src.ElementTree), \hyperpage{33}
+ \item end() (src.ElementTree.TreeBuilder method), \hyperpage{33}
+ \item end\_write() (src.logger.Logger method), \hyperpage{47}
+ \item ensure\_path\_exists() (in module src), \hyperpage{67}
+ \item Environ (class in src.environment), \hyperpage{36}
+ \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item error() (src.logger.Logger method), \hyperpage{47}
+ \item evaluate() (src.pyconf.Container method), \hyperpage{59}
+ \item evaluate() (src.pyconf.Expression method), \hyperpage{60}
+ \item exists() (src.Path method), \hyperpage{66}
+ \item Expression (class in src.pyconf), \hyperpage{59}
+ \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
\indexspace
\bigletter F
- \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32}
- \item FileEnviron (class in src.fileEnviron), \hyperpage{40}
- \item FileEnvWriter (class in src.environment), \hyperpage{36}
- \item find() (src.ElementTree.ElementTree method), \hyperpage{31}
- \item find\_file\_in\_lpath() (in module src.\_\_init\_\_), \hyperpage{30}
- \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{64}
- \item findall() (src.ElementTree.ElementTree method), \hyperpage{31}
- \item findConfig() (src.pyconf.Reference method), \hyperpage{59}
- \item findtext() (src.ElementTree.ElementTree method), \hyperpage{32}
- \item finish() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{39}
- \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{39}
- \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item flush() (src.logger.Logger method), \hyperpage{45}
- \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{56}
- \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item fromstring() (in module src.ElementTree), \hyperpage{32}
+ \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{33}
+ \item FileEnviron (class in src.fileEnviron), \hyperpage{42}
+ \item FileEnvWriter (class in src.environment), \hyperpage{37}
+ \item filterLevel() (src.options.Options method), \hyperpage{48}
+ \item filterList2() (src.options.Options method), \hyperpage{48}
+ \item find() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item find\_file\_in\_lpath() (in module src), \hyperpage{67}
+ \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{65}
+ \item findall() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item findConfig() (src.pyconf.Reference method), \hyperpage{60}
+ \item findtext() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item finish() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{40}
+ \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{40}
+ \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item flush() (src.logger.Logger method), \hyperpage{47}
+ \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{57}
+ \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+ \item fromstring() (in module src.ElementTree), \hyperpage{33}
\indexspace
\bigletter G
- \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{62}
- \item generate\_script() (src.test\_module.Test method), \hyperpage{62}
- \item get() (src.environment.Environ method), \hyperpage{35}
- \item get() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{39}
- \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item get() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item get() (src.pyconf.Mapping method), \hyperpage{58}
- \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{63}
- \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item get\_base\_install\_dir() (in module src.product), \hyperpage{49}
- \item get\_base\_path() (in module src.\_\_init\_\_), \hyperpage{30}
- \item get\_cfg\_param() (in module src.\_\_init\_\_), \hyperpage{30}
- \item get\_distrib\_version() (in module src.architecture), \hyperpage{32}
- \item get\_distribution() (in module src.architecture), \hyperpage{32}
- \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{44}
- \item get\_install\_dir() (in module src.product), \hyperpage{50}
- \item get\_launcher\_name() (in module src.\_\_init\_\_), \hyperpage{30}
- \item get\_log\_path() (in module src.\_\_init\_\_), \hyperpage{31}
- \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item get\_nb\_proc() (in module src.architecture), \hyperpage{33}
- \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{63}
- \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item get\_product\_components() (in module src.product), \hyperpage{50}
- \item get\_product\_config() (in module src.product), \hyperpage{50}
- \item get\_product\_dependencies() (in module src.product), \hyperpage{50}
- \item get\_product\_section() (in module src.product), \hyperpage{50}
- \item get\_products\_infos() (in module src.product), \hyperpage{51}
- \item get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_), \hyperpage{31}
- \item get\_python\_version() (in module src.architecture), \hyperpage{33}
- \item get\_salome\_version() (in module src.\_\_init\_\_), \hyperpage{31}
- \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{62}
- \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{62}
- \item get\_tmp\_filename() (in module src.\_\_init\_\_), \hyperpage{31}
- \item get\_user() (in module src.architecture), \hyperpage{33}
- \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item getByPath() (src.pyconf.Config method), \hyperpage{54}
- \item getByPath() (src.pyconf.ConfigList method), \hyperpage{55}
- \item getChar() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{32}
- \item getLocalEnv() (in module src.debug), \hyperpage{34}
- \item getroot() (src.ElementTree.ElementTree method), \hyperpage{32}
- \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{62}
- \item getStrConfigDbg() (in module src.debug), \hyperpage{34}
- \item getStrConfigStd() (in module src.debug), \hyperpage{34}
- \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{62}
- \item getToken() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item git\_extract() (in module src.system), \hyperpage{61}
- \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{67}
- \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{67}
+ \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{63}
+ \item generate\_script() (src.test\_module.Test method), \hyperpage{63}
+ \item get() (src.environment.Environ method), \hyperpage{36}
+ \item get() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{41}
+ \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item get() (src.fileEnviron.FileEnviron method), \hyperpage{42}
+ \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item get() (src.pyconf.Mapping method), \hyperpage{60}
+ \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{64}
+ \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item get\_base\_install\_dir() (in module src.product), \hyperpage{51}
+ \item get\_base\_path() (in module src), \hyperpage{67}
+ \item get\_cfg\_param() (in module src), \hyperpage{67}
+ \item get\_distrib\_version() (in module src.architecture), \hyperpage{34}
+ \item get\_distribution() (in module src.architecture), \hyperpage{34}
+ \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{46}
+ \item get\_help() (src.options.Options method), \hyperpage{49}
+ \item get\_install\_dir() (in module src.product), \hyperpage{51}
+ \item get\_launcher\_name() (in module src), \hyperpage{67}
+ \item get\_log\_path() (in module src), \hyperpage{67}
+ \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item get\_nb\_proc() (in module src.architecture), \hyperpage{34}
+ \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{64}
+ \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item get\_product\_components() (in module src.product), \hyperpage{51}
+ \item get\_product\_config() (in module src.product), \hyperpage{52}
+ \item get\_product\_dependencies() (in module src.product), \hyperpage{52}
+ \item get\_product\_section() (in module src.product), \hyperpage{52}
+ \item get\_products\_infos() (in module src.product), \hyperpage{52}
+ \item get\_property\_in\_product\_cfg() (in module src), \hyperpage{67}
+ \item get\_python\_version() (in module src.architecture), \hyperpage{34}
+ \item get\_salome\_version() (in module src), \hyperpage{67}
+ \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{63}
+ \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{63}
+ \item get\_tmp\_filename() (in module src), \hyperpage{67}
+ \item get\_user() (in module src.architecture), \hyperpage{34}
+ \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item getByPath() (src.pyconf.Config method), \hyperpage{56}
+ \item getByPath() (src.pyconf.ConfigList method), \hyperpage{56}
+ \item getChar() (src.pyconf.ConfigReader method), \hyperpage{57}
+ \item getDetailOption() (src.options.Options method), \hyperpage{48}
+ \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item getLocalEnv() (in module src.debug), \hyperpage{35}
+ \item getroot() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{64}
+ \item getStrConfigDbg() (in module src.debug), \hyperpage{35}
+ \item getStrConfigStd() (in module src.debug), \hyperpage{36}
+ \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{64}
+ \item getToken() (src.pyconf.ConfigReader method), \hyperpage{57}
+ \item git\_extract() (in module src.system), \hyperpage{62}
+ \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+ \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{32}
\indexspace
\bigletter H
- \item hack\_libtool() (src.compilation.Builder method), \hyperpage{33}
- \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{55}
- \item handleRemoveReadonly() (in module src.\_\_init\_\_), \hyperpage{31}
+ \item hack\_libtool() (src.compilation.Builder method), \hyperpage{35}
+ \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{57}
+ \item handleRemoveReadonly() (in module src), \hyperpage{68}
\indexspace
\bigletter I
- \item indent() (in module src.debug), \hyperpage{34}
- \item init() (in module src.colorama.initialise), \hyperpage{67}
- \item install() (src.compilation.Builder method), \hyperpage{33}
- \item InStream (class in src.debug), \hyperpage{34}
- \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{66}
- \item is\_defined() (src.environment.Environ method), \hyperpage{35}
- \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{66}
- \item is\_windows() (in module src.architecture), \hyperpage{33}
- \item isdir() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item iselement() (in module src.ElementTree), \hyperpage{32}
- \item isfile() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item islink() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item isWord() (in module src.pyconf), \hyperpage{60}
- \item iteritems() (src.pyconf.Mapping method), \hyperpage{58}
- \item iterkeys() (src.pyconf.Mapping method), \hyperpage{58}
- \item iterparse (class in src.ElementTree), \hyperpage{32}
+ \item indent() (in module src.debug), \hyperpage{36}
+ \item indent() (src.options.Options method), \hyperpage{49}
+ \item init() (in module src.colorama.initialise), \hyperpage{31}
+ \item install() (src.compilation.Builder method), \hyperpage{35}
+ \item InStream (class in src.debug), \hyperpage{35}
+ \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{31}
+ \item is\_defined() (src.environment.Environ method), \hyperpage{36}
+ \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{43}
+ \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{31}
+ \item is\_windows() (in module src.architecture), \hyperpage{34}
+ \item isdir() (src.Path method), \hyperpage{66}
+ \item iselement() (in module src.ElementTree), \hyperpage{33}
+ \item isfile() (src.Path method), \hyperpage{66}
+ \item islink() (src.Path method), \hyperpage{66}
+ \item isWord() (in module src.pyconf), \hyperpage{61}
+ \item iteritems() (src.pyconf.Mapping method), \hyperpage{60}
+ \item iterkeys() (src.pyconf.Mapping method), \hyperpage{60}
+ \item iterparse (class in src.ElementTree), \hyperpage{33}
\indexspace
\bigletter K
- \item keys() (src.pyconf.Mapping method), \hyperpage{58}
+ \item keys() (src.pyconf.Mapping method), \hyperpage{60}
\indexspace
\bigletter L
- \item launch\_command() (in module src.fork), \hyperpage{45}
- \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{42}
- \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{64}
- \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item list() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item list\_log\_file() (in module src.logger), \hyperpage{46}
- \item load() (src.pyconf.Config method), \hyperpage{54}
- \item load() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item load\_environment() (in module src.environment), \hyperpage{38}
- \item location() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item log() (src.compilation.Builder method), \hyperpage{33}
- \item log\_command() (src.compilation.Builder method), \hyperpage{33}
- \item Logger (class in src.logger), \hyperpage{45}
+ \item launch\_command() (in module src.fork), \hyperpage{46}
+ \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{43}
+ \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item list() (src.Path method), \hyperpage{66}
+ \item list\_log\_file() (in module src.logger), \hyperpage{47}
+ \item load() (src.pyconf.Config method), \hyperpage{56}
+ \item load() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item load\_environment() (in module src.environment), \hyperpage{40}
+ \item location() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item log() (src.compilation.Builder method), \hyperpage{35}
+ \item log\_command() (src.compilation.Builder method), \hyperpage{35}
+ \item Logger (class in src.logger), \hyperpage{46}
\indexspace
\bigletter M
- \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{67}
- \item make() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item make() (src.compilation.Builder method), \hyperpage{33}
- \item makePath() (in module src.pyconf), \hyperpage{60}
- \item Mapping (class in src.pyconf), \hyperpage{58}
- \item match() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item merge() (src.pyconf.ConfigMerger method), \hyperpage{55}
- \item merge\_dicts() (in module src.\_\_init\_\_), \hyperpage{31}
- \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{55}
- \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{56}
- \item MyTemplate (class in src.template), \hyperpage{62}
+ \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+ \item make() (src.compilation.Builder method), \hyperpage{35}
+ \item make() (src.Path method), \hyperpage{66}
+ \item makePath() (in module src.pyconf), \hyperpage{61}
+ \item Mapping (class in src.pyconf), \hyperpage{60}
+ \item match() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item merge() (src.pyconf.ConfigMerger method), \hyperpage{57}
+ \item merge\_dicts() (in module src), \hyperpage{68}
+ \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{57}
+ \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{57}
+ \item MyTemplate (class in src.template), \hyperpage{63}
\indexspace
\bigletter N
- \item next() (src.ElementTree.iterparse method), \hyperpage{32}
- \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{59}
- \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66}
- \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{67}
+ \item next() (src.ElementTree.iterparse method), \hyperpage{33}
+ \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{61}
+ \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+ \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
\indexspace
\bigletter O
- \item only\_numbers() (in module src.\_\_init\_\_), \hyperpage{31}
- \item Options (class in src.options), \hyperpage{47}
- \item OptResult (class in src.options), \hyperpage{47}
- \item OutStream (class in src.debug), \hyperpage{34}
- \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{56}
- \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{60}
+ \item only\_numbers() (in module src), \hyperpage{68}
+ \item Options (class in src.options), \hyperpage{48}
+ \item OptResult (class in src.options), \hyperpage{48}
+ \item OutStream (class in src.debug), \hyperpage{35}
+ \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{57}
+ \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{62}
\indexspace
\bigletter P
- \item parse() (in module src.ElementTree), \hyperpage{32}
- \item parse() (src.ElementTree.ElementTree method), \hyperpage{32}
- \item parse\_args() (src.options.Options method), \hyperpage{47}
- \item parse\_date() (in module src.\_\_init\_\_), \hyperpage{31}
- \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{56}
- \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item Path (class in src.\_\_init\_\_), \hyperpage{29}
- \item pattern (src.template.MyTemplate attribute), \hyperpage{62}
- \item PI() (in module src.ElementTree), \hyperpage{32}
- \item pop\_debug() (in module src.debug), \hyperpage{34}
- \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item prepare() (src.compilation.Builder method), \hyperpage{33}
- \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{62}
- \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{62}
- \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{62}
- \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{62}
- \item prepend() (src.environment.Environ method), \hyperpage{35}
- \item prepend() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{41}
- \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item prepend\_value() (src.environment.Environ method), \hyperpage{35}
- \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{42}
- \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item print\_color\_map() (in module src.printcolors), \hyperpage{47}
- \item print\_color\_range() (in module src.printcolors), \hyperpage{48}
- \item print\_help() (src.options.Options method), \hyperpage{47}
- \item print\_info() (in module src.\_\_init\_\_), \hyperpage{31}
- \item print\_value() (in module src.printcolors), \hyperpage{48}
- \item printc() (in module src.printcolors), \hyperpage{48}
- \item printcError() (in module src.printcolors), \hyperpage{48}
- \item printcHeader() (in module src.printcolors), \hyperpage{48}
- \item printcHighlight() (in module src.printcolors), \hyperpage{48}
- \item printcInfo() (in module src.printcolors), \hyperpage{48}
- \item printcLabel() (in module src.printcolors), \hyperpage{49}
- \item printcSuccess() (in module src.printcolors), \hyperpage{49}
- \item printcWarning() (in module src.printcolors), \hyperpage{49}
- \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{32}
- \item product\_compiles() (in module src.product), \hyperpage{51}
- \item product\_has\_env\_script() (in module src.product), \hyperpage{51}
- \item product\_has\_logo() (in module src.product), \hyperpage{51}
- \item product\_has\_patches() (in module src.product), \hyperpage{51}
- \item product\_has\_salome\_gui() (in module src.product), \hyperpage{51}
- \item product\_has\_script() (in module src.product), \hyperpage{51}
- \item product\_is\_autotools() (in module src.product), \hyperpage{51}
- \item product\_is\_cmake() (in module src.product), \hyperpage{52}
- \item product\_is\_cpp() (in module src.product), \hyperpage{52}
- \item product\_is\_debug() (in module src.product), \hyperpage{52}
- \item product\_is\_dev() (in module src.product), \hyperpage{52}
- \item product\_is\_fixed() (in module src.product), \hyperpage{52}
- \item product\_is\_generated() (in module src.product), \hyperpage{52}
- \item product\_is\_mpi() (in module src.product), \hyperpage{52}
- \item product\_is\_native() (in module src.product), \hyperpage{52}
- \item product\_is\_salome() (in module src.product), \hyperpage{53}
- \item product\_is\_sample() (in module src.product), \hyperpage{53}
- \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{53}
- \item product\_is\_vcs() (in module src.product), \hyperpage{53}
- \item push\_debug() (in module src.debug), \hyperpage{34}
- \item put\_initial\_xml\_fields() (src.logger.Logger method), \hyperpage{46}
- \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{33}
+ \item parse() (in module src.ElementTree), \hyperpage{33}
+ \item parse() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item parse\_args() (src.options.Options method), \hyperpage{49}
+ \item parse\_date() (in module src), \hyperpage{68}
+ \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{58}
+ \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{59}
+ \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{59}
+ \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{59}
+ \item Path (class in src), \hyperpage{66}
+ \item pattern (src.template.MyTemplate attribute), \hyperpage{63}
+ \item PI() (in module src.ElementTree), \hyperpage{33}
+ \item pop\_debug() (in module src.debug), \hyperpage{36}
+ \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+ \item prepare() (src.compilation.Builder method), \hyperpage{35}
+ \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{63}
+ \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{64}
+ \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{64}
+ \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{64}
+ \item prepend() (src.environment.Environ method), \hyperpage{37}
+ \item prepend() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{43}
+ \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item prepend\_value() (src.environment.Environ method), \hyperpage{37}
+ \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{43}
+ \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item print\_color\_map() (in module src.printcolors), \hyperpage{49}
+ \item print\_color\_range() (in module src.printcolors), \hyperpage{49}
+ \item print\_help() (src.options.Options method), \hyperpage{49}
+ \item print\_info() (in module src), \hyperpage{68}
+ \item print\_value() (in module src.printcolors), \hyperpage{49}
+ \item printc() (in module src.printcolors), \hyperpage{49}
+ \item printcError() (in module src.printcolors), \hyperpage{50}
+ \item printcHeader() (in module src.printcolors), \hyperpage{50}
+ \item printcHighlight() (in module src.printcolors), \hyperpage{50}
+ \item printcInfo() (in module src.printcolors), \hyperpage{50}
+ \item printcLabel() (in module src.printcolors), \hyperpage{50}
+ \item printcSuccess() (in module src.printcolors), \hyperpage{50}
+ \item printcWarning() (in module src.printcolors), \hyperpage{50}
+ \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{33}
+ \item product\_compiles() (in module src.product), \hyperpage{52}
+ \item product\_has\_env\_script() (in module src.product), \hyperpage{52}
+ \item product\_has\_logo() (in module src.product), \hyperpage{53}
+ \item product\_has\_patches() (in module src.product), \hyperpage{53}
+ \item product\_has\_salome\_gui() (in module src.product), \hyperpage{53}
+ \item product\_has\_script() (in module src.product), \hyperpage{53}
+ \item product\_is\_autotools() (in module src.product), \hyperpage{53}
+ \item product\_is\_cmake() (in module src.product), \hyperpage{53}
+ \item product\_is\_cpp() (in module src.product), \hyperpage{53}
+ \item product\_is\_debug() (in module src.product), \hyperpage{53}
+ \item product\_is\_dev() (in module src.product), \hyperpage{54}
+ \item product\_is\_fixed() (in module src.product), \hyperpage{54}
+ \item product\_is\_generated() (in module src.product), \hyperpage{54}
+ \item product\_is\_mpi() (in module src.product), \hyperpage{54}
+ \item product\_is\_native() (in module src.product), \hyperpage{54}
+ \item product\_is\_salome() (in module src.product), \hyperpage{54}
+ \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{54}
+ \item product\_is\_vcs() (in module src.product), \hyperpage{54}
+ \item product\_is\_verbose() (in module src.product), \hyperpage{54}
+ \item push\_debug() (in module src.debug), \hyperpage{36}
+ \item put\_initial\_xml\_fields() (src.logger.Logger method), \hyperpage{47}
+ \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{35}
\indexspace
\bigletter Q
- \item QName (class in src.ElementTree), \hyperpage{32}
+ \item QName (class in src.ElementTree), \hyperpage{33}
\indexspace
\bigletter R
- \item read() (src.pyconf.ConfigInputStream method), \hyperpage{55}
- \item read\_config\_from\_a\_file() (in module src.\_\_init\_\_), \hyperpage{31}
- \item read\_results() (src.test\_module.Test method), \hyperpage{62}
- \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{55}
- \item readlink() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item ReadXmlFile (class in src.xmlManager), \hyperpage{62}
- \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{67}
- \item Reference (class in src.pyconf), \hyperpage{59}
- \item reinit() (in module src.colorama.initialise), \hyperpage{67}
- \item remove\_item\_from\_list() (in module src.\_\_init\_\_), \hyperpage{31}
- \item removeNamespace() (src.pyconf.Config method), \hyperpage{55}
- \item replace\_in\_file() (in module src.\_\_init\_\_), \hyperpage{31}
- \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66}
- \item reset\_all() (in module src.colorama.initialise), \hyperpage{67}
- \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item resolve() (src.pyconf.Reference method), \hyperpage{59}
- \item rm() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{62}
- \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{62}
- \item run\_script() (src.test\_module.Test method), \hyperpage{62}
- \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{62}
- \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{62}
- \item run\_tests() (src.test\_module.Test method), \hyperpage{62}
+ \item read() (src.pyconf.ConfigInputStream method), \hyperpage{56}
+ \item read\_config\_from\_a\_file() (in module src), \hyperpage{68}
+ \item read\_results() (src.test\_module.Test method), \hyperpage{64}
+ \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{56}
+ \item readlink() (src.Path method), \hyperpage{66}
+ \item ReadXmlFile (class in src.xmlManager), \hyperpage{64}
+ \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+ \item Reference (class in src.pyconf), \hyperpage{60}
+ \item reinit() (in module src.colorama.initialise), \hyperpage{31}
+ \item remove\_item\_from\_list() (in module src), \hyperpage{68}
+ \item removeNamespace() (src.pyconf.Config method), \hyperpage{56}
+ \item replace\_in\_file() (in module src), \hyperpage{68}
+ \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+ \item reset\_all() (in module src.colorama.initialise), \hyperpage{31}
+ \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item resolve() (src.pyconf.Reference method), \hyperpage{60}
+ \item rm() (src.Path method), \hyperpage{66}
+ \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{64}
+ \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{38}
+ \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{64}
+ \item run\_script() (src.test\_module.Test method), \hyperpage{64}
+ \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{64}
+ \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{64}
+ \item run\_tests() (src.test\_module.Test method), \hyperpage{64}
\indexspace
\bigletter S
- \item SalomeEnviron (class in src.environment), \hyperpage{36}
- \item SatException, \hyperpage{29}
- \item saveConfigDbg() (in module src.debug), \hyperpage{34}
- \item saveConfigStd() (in module src.debug), \hyperpage{34}
- \item ScreenEnviron (class in src.fileEnviron), \hyperpage{43}
- \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{62}
- \item Sequence (class in src.pyconf), \hyperpage{59}
- \item Sequence.SeqIter (class in src.pyconf), \hyperpage{59}
- \item set() (src.environment.Environ method), \hyperpage{36}
- \item set() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{39}
- \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{39}
- \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40}
- \item set() (src.fileEnviron.FileEnviron method), \hyperpage{42}
- \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43}
- \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{37}
- \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{67}
- \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{68}
- \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{38}
- \item set\_title() (in module src.colorama.ansi), \hyperpage{66}
- \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{68}
- \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{67}
- \item setPath() (src.pyconf.Container method), \hyperpage{58}
- \item setStream() (src.pyconf.ConfigReader method), \hyperpage{57}
- \item Shell (class in src.environment), \hyperpage{38}
- \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item show\_command\_log() (in module src.logger), \hyperpage{46}
- \item show\_in\_editor() (in module src.system), \hyperpage{61}
- \item show\_progress() (in module src.fork), \hyperpage{45}
- \item smartcopy() (src.\_\_init\_\_.Path method), \hyperpage{29}
- \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{44}
- \item src.\_\_init\_\_ (module), \hyperpage{29}
- \item src.architecture (module), \hyperpage{32}
- \item src.colorama (module), \hyperpage{64}
- \item src.colorama.ansi (module), \hyperpage{64}
- \item src.colorama.ansitowin32 (module), \hyperpage{66}
- \item src.colorama.initialise (module), \hyperpage{67}
- \item src.colorama.win32 (module), \hyperpage{67}
- \item src.colorama.winterm (module), \hyperpage{67}
- \item src.compilation (module), \hyperpage{33}
- \item src.debug (module), \hyperpage{34}
- \item src.ElementTree (module), \hyperpage{31}
- \item src.environment (module), \hyperpage{35}
- \item src.fileEnviron (module), \hyperpage{39}
- \item src.fork (module), \hyperpage{45}
- \item src.logger (module), \hyperpage{45}
- \item src.options (module), \hyperpage{47}
- \item src.printcolors (module), \hyperpage{47}
- \item src.product (module), \hyperpage{49}
- \item src.pyconf (module), \hyperpage{53}
- \item src.system (module), \hyperpage{60}
- \item src.template (module), \hyperpage{62}
- \item src.test\_module (module), \hyperpage{62}
- \item src.xmlManager (module), \hyperpage{62}
- \item start() (src.ElementTree.TreeBuilder method), \hyperpage{32}
- \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{66}
- \item style() (src.colorama.winterm.WinTerm method), \hyperpage{68}
- \item SubElement() (in module src.ElementTree), \hyperpage{32}
- \item substitute() (in module src.template), \hyperpage{62}
- \item svn\_extract() (in module src.system), \hyperpage{61}
- \item symlink() (src.\_\_init\_\_.Path method), \hyperpage{29}
+ \item SalomeEnviron (class in src.environment), \hyperpage{37}
+ \item SatException, \hyperpage{66}
+ \item saveConfigDbg() (in module src.debug), \hyperpage{36}
+ \item saveConfigStd() (in module src.debug), \hyperpage{36}
+ \item ScreenEnviron (class in src.fileEnviron), \hyperpage{44}
+ \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{64}
+ \item Sequence (class in src.pyconf), \hyperpage{60}
+ \item Sequence.SeqIter (class in src.pyconf), \hyperpage{61}
+ \item set() (src.environment.Environ method), \hyperpage{37}
+ \item set() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{40}
+ \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{41}
+ \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{41}
+ \item set() (src.fileEnviron.FileEnviron method), \hyperpage{43}
+ \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{44}
+ \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{45}
+ \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{39}
+ \item set\_title() (in module src.colorama.ansi), \hyperpage{30}
+ \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{32}
+ \item setPath() (src.pyconf.Container method), \hyperpage{59}
+ \item setStream() (src.pyconf.ConfigReader method), \hyperpage{59}
+ \item Shell (class in src.environment), \hyperpage{40}
+ \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item show\_command\_log() (in module src.logger), \hyperpage{47}
+ \item show\_in\_editor() (in module src.system), \hyperpage{63}
+ \item show\_progress() (in module src.fork), \hyperpage{46}
+ \item smartcopy() (src.Path method), \hyperpage{66}
+ \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{46}
+ \item src (module), \hyperpage{66}
+ \item src.architecture (module), \hyperpage{34}
+ \item src.colorama (module), \hyperpage{33}
+ \item src.colorama.ansi (module), \hyperpage{29}
+ \item src.colorama.ansitowin32 (module), \hyperpage{31}
+ \item src.colorama.initialise (module), \hyperpage{31}
+ \item src.colorama.win32 (module), \hyperpage{32}
+ \item src.colorama.winterm (module), \hyperpage{32}
+ \item src.compilation (module), \hyperpage{34}
+ \item src.debug (module), \hyperpage{35}
+ \item src.ElementTree (module), \hyperpage{33}
+ \item src.environment (module), \hyperpage{36}
+ \item src.fileEnviron (module), \hyperpage{40}
+ \item src.fork (module), \hyperpage{46}
+ \item src.logger (module), \hyperpage{46}
+ \item src.options (module), \hyperpage{48}
+ \item src.printcolors (module), \hyperpage{49}
+ \item src.product (module), \hyperpage{50}
+ \item src.pyconf (module), \hyperpage{55}
+ \item src.system (module), \hyperpage{62}
+ \item src.template (module), \hyperpage{63}
+ \item src.test\_module (module), \hyperpage{63}
+ \item src.xmlManager (module), \hyperpage{64}
+ \item start() (src.ElementTree.TreeBuilder method), \hyperpage{33}
+ \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{31}
+ \item style() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+ \item SubElement() (in module src.ElementTree), \hyperpage{33}
+ \item substitute() (in module src.template), \hyperpage{63}
+ \item svn\_extract() (in module src.system), \hyperpage{63}
+ \item symlink() (src.Path method), \hyperpage{66}
\indexspace
\bigletter T
- \item Test (class in src.test\_module), \hyperpage{62}
- \item timedelta\_total\_seconds() (in module src.logger), \hyperpage{46}
- \item tofix() (in module src.debug), \hyperpage{35}
- \item tostring() (in module src.ElementTree), \hyperpage{32}
- \item TreeBuilder (class in src.ElementTree), \hyperpage{32}
+ \item Test (class in src.test\_module), \hyperpage{63}
+ \item timedelta\_total\_seconds() (in module src.logger), \hyperpage{47}
+ \item tofix() (in module src.debug), \hyperpage{36}
+ \item tostring() (in module src.ElementTree), \hyperpage{33}
+ \item TreeBuilder (class in src.ElementTree), \hyperpage{33}
\indexspace
\bigletter U
- \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item update\_hat\_xml() (in module src.logger), \hyperpage{46}
+ \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+ \item update\_hat\_xml() (in module src.logger), \hyperpage{48}
\indexspace
\bigletter W
- \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item winapi\_test() (in module src.colorama.win32), \hyperpage{67}
- \item WinColor (class in src.colorama.winterm), \hyperpage{67}
- \item WinStyle (class in src.colorama.winterm), \hyperpage{67}
- \item WinTerm (class in src.colorama.winterm), \hyperpage{67}
- \item wmake() (src.compilation.Builder method), \hyperpage{34}
- \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{67}
- \item write() (in module src.debug), \hyperpage{35}
- \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{66}
- \item write() (src.ElementTree.ElementTree method), \hyperpage{32}
- \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{44}
- \item write() (src.logger.Logger method), \hyperpage{46}
- \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{56}
- \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item write\_back() (in module src.fork), \hyperpage{45}
- \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{36}
- \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{36}
- \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66}
- \item write\_report() (in module src.xmlManager), \hyperpage{64}
- \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{62}
- \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{63}
- \item writeToStream() (src.pyconf.Container method), \hyperpage{58}
- \item writeToStream() (src.pyconf.Mapping method), \hyperpage{59}
- \item writeToStream() (src.pyconf.Sequence method), \hyperpage{59}
- \item writeValue() (src.pyconf.Container method), \hyperpage{58}
+ \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item winapi\_test() (in module src.colorama.win32), \hyperpage{32}
+ \item WinColor (class in src.colorama.winterm), \hyperpage{32}
+ \item WinStyle (class in src.colorama.winterm), \hyperpage{32}
+ \item WinTerm (class in src.colorama.winterm), \hyperpage{32}
+ \item wmake() (src.compilation.Builder method), \hyperpage{35}
+ \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{31}
+ \item write() (in module src.debug), \hyperpage{36}
+ \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{31}
+ \item write() (src.ElementTree.ElementTree method), \hyperpage{33}
+ \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{46}
+ \item write() (src.logger.Logger method), \hyperpage{47}
+ \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{57}
+ \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item write\_back() (in module src.fork), \hyperpage{46}
+ \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{37}
+ \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{37}
+ \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+ \item write\_report() (in module src.xmlManager), \hyperpage{65}
+ \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{64}
+ \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{65}
+ \item writeToStream() (src.pyconf.Container method), \hyperpage{59}
+ \item writeToStream() (src.pyconf.Mapping method), \hyperpage{60}
+ \item writeToStream() (src.pyconf.Sequence method), \hyperpage{61}
+ \item writeValue() (src.pyconf.Container method), \hyperpage{59}
\indexspace
\bigletter X
- \item XML() (in module src.ElementTree), \hyperpage{32}
- \item XmlLogFile (class in src.xmlManager), \hyperpage{63}
- \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{32}
+ \item XML() (in module src.ElementTree), \hyperpage{33}
+ \item XmlLogFile (class in src.xmlManager), \hyperpage{64}
+ \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{33}
\indexspace
\bigletter Y
- \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{65}
- \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{65}
- \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{67}
+ \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+ \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+ \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{32}
\end{sphinxtheindex}
-This is pdfTeX, Version 3.14159265-2.6-1.40.18 (TeX Live 2017) (preloaded format=pdflatex 2018.4.13) 25 APR 2018 12:49
+This is pdfTeX, Version 3.14159265-2.6-1.40.18 (TeX Live 2017) (preloaded format=pdflatex 2018.4.13) 19 JUN 2018 11:14
entering extended mode
restricted \write18 enabled.
%&-line parsing enabled.
))
(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
Package: times 2005/04/12 PSNFSS-v9.2a (SPQR)
-)
-(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncycha
-p.sty
+) (./fncychap.sty
Package: fncychap 2007/07/30 v1.34 LaTeX package (Revised chapters)
\RW=\skip46
\mylen=\skip47
\titlewidth=\dimen117
\titlewidthlast=\dimen118
\titlewidthfirst=\dimen119
-)
-(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabular
-y.sty
-Package: tabulary 2014/06/11 v0.10 tabulary package (DPC)
+) (./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)
] [2
]
-<sat_about.png, id=144, 602.25pt x 301.125pt>
+<sat_about.png, id=149, 602.25pt x 301.125pt>
LaTeX Font Info: Try loading font information for T1+pcr on input line 74.
(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
] [8
-] [9] [10
+] [9
-] [11] [12
+] [10] [11
-] [13] [14
+] [12] [13
-] [15
+] [14] [15
] [16
] [17
+] [18
+
]
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 1176.
- [18] [19] [20
-
-] [21
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 1242.
+ [19] [20] [21
]
-[22] [23
+[22
-] [24
+] [23] [24
]
Chapter 3.
-[25] [26
+[25
+
+] [26
] [27] [28]
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 1664.
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 1746.
LaTeX Font Info: Font shape `T1/pcr/m/it' in size <10> not available
-(Font) Font shape `T1/pcr/m/sl' tried instead on input line 1792.
+(Font) Font shape `T1/pcr/m/sl' tried instead on input line 1747.
[29
-]
-LaTeX Font Info: Font shape `TS1/pcr/bx/n' in size <10> not available
-(Font) Font shape `TS1/pcr/b/n' tried instead on input line 1.
- [30] [31] [32] [33] [34] [35]
-Underfull \hbox (badness 10000) in paragraph at lines 2847--2847
+] [30] [31] [32] [33]
+Underfull \hbox (badness 10000) in paragraph at lines 2732--2732
+[]\T1/ptm/m/it/10 config\T1/ptm/m/n/10 , \T1/ptm/m/it/10 log-ger\T1/ptm/m/n/10
+, \T1/ptm/m/it/10 prod-uct_info\T1/ptm/m/n/10 , \T1/ptm/m/it/10 op-tions=OptRes
+ult( )\T1/ptm/m/n/10 ,
+ []
+
+[34] [35] [36]
+Underfull \hbox (badness 10000) in paragraph at lines 3174--3174
[]\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 ,
[]
-[36] [37] [38] [39] [40] [41] [42] [43] [44]
-Underfull \hbox (badness 10000) in paragraph at lines 4366--4366
+[37] [38] [39] [40] [41] [42] [43] [44] [45]
+Underfull \hbox (badness 10000) in paragraph at lines 4693--4693
[]\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-
[]
-[45] [46] [47] [48] [49] [50] [51] [52] [53] [54] [55] [56] [57] [58] [59]
-Underfull \hbox (badness 10000) in paragraph at lines 6557--6561
+[46] [47] [48] [49] [50] [51] [52] [53] [54] [55] [56] [57] [58] [59] [60]
+Underfull \hbox (badness 10000) in paragraph at lines 6933--6937
[]\T1/ptm/m/n/10 Examples: makePath(`', `suf-fix') -> `suf-fix' makePath(`prefi
x', `suf-fix') -> `pre-fix.suffix'
[]
-[60] [61] [62] [63]
-Underfull \hbox (badness 10000) in paragraph at lines 7119--7121
+[61] [62]
+LaTeX Font Info: Font shape `TS1/pcr/bx/n' in size <10> not available
+(Font) Font shape `TS1/pcr/b/n' tried instead on input line 1.
+ [63] [64]
+Underfull \hbox (badness 10000) in paragraph at lines 7495--7497
[]\T1/ptm/m/n/10 its at-tributes {key :
[]
-[64] [65] [66] [67] [68]
+[65] [66] [67] [68]
Chapter 5.
[69
[]
-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 145--146
+Underfull \hbox (badness 10000) in paragraph at lines 146--147
[]\T1/ptm/m/n/10 do_batch_script_build() (src.compilation.Builder
[]
-Underfull \hbox (badness 10000) in paragraph at lines 147--148
+Underfull \hbox (badness 10000) in paragraph at lines 148--149
[]\T1/ptm/m/n/10 do_python_script_build() (src.compilation.Builder
[]
-Underfull \hbox (badness 10000) in paragraph at lines 163--164
+Underfull \hbox (badness 10000) in paragraph at lines 164--165
[]\T1/ptm/m/n/10 erase_screen() (src.colorama.winterm.WinTerm
[]
-[74]
-Overfull \hbox (12.37378pt too wide) in paragraph at lines 169--170
+
+Overfull \hbox (12.37378pt too wide) in paragraph at lines 170--171
[]\T1/ptm/m/n/10 extract_params() (src.colorama.ansitowin32.AnsiToWin32
[]
-
-Underfull \hbox (badness 10000) in paragraph at lines 219--220
+[74]
+Underfull \hbox (badness 10000) in paragraph at lines 223--224
[]\T1/ptm/m/n/10 get_node_text() (src.xmlManager.ReadXmlFile
[]
-Underfull \hbox (badness 10000) in paragraph at lines 220--221
+Underfull \hbox (badness 10000) in paragraph at lines 224--225
[]\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.98375pt too wide) in paragraph at lines 233--234
+Overfull \hbox (16.98375pt too wide) in paragraph at lines 237--238
[]\T1/ptm/m/n/10 get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32
[]
-Underfull \hbox (badness 10000) in paragraph at lines 240--241
+Underfull \hbox (badness 10000) in paragraph at lines 245--246
[]\T1/ptm/m/n/10 getRootAttrib() (src.xmlManager.ReadXmlFile
[]
-Underfull \hbox (badness 10000) in paragraph at lines 267--268
+Underfull \hbox (badness 10000) in paragraph at lines 273--274
[]\T1/ptm/m/n/10 is_defined() (src.fileEnviron.LauncherFileEnviron
[]
-
-Underfull \hbox (badness 10000) in paragraph at lines 269--270
+[75]
+Underfull \hbox (badness 10000) in paragraph at lines 275--276
[]\T1/ptm/m/n/10 is_stream_closed() (in mod-ule
[]
-[75]
-Underfull \hbox (badness 5260) in paragraph at lines 289--290
+
+Underfull \hbox (badness 5260) in paragraph at lines 295--296
[]\T1/ptm/m/n/10 LIGHTBLACK_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 290--291
+Underfull \hbox (badness 10000) in paragraph at lines 296--297
[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiBack at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 291--292
+Underfull \hbox (badness 10000) in paragraph at lines 297--298
[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 292--293
+Underfull \hbox (badness 10000) in paragraph at lines 298--299
[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiBack
[]
-Underfull \hbox (badness 10000) in paragraph at lines 293--294
+Underfull \hbox (badness 10000) in paragraph at lines 299--300
[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 5490) in paragraph at lines 295--296
+Underfull \hbox (badness 5490) in paragraph at lines 301--302
[]\T1/ptm/m/n/10 LIGHTGREEN_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 296--297
+Underfull \hbox (badness 10000) in paragraph at lines 302--303
[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack
[]
-Underfull \hbox (badness 10000) in paragraph at lines 297--298
+Underfull \hbox (badness 10000) in paragraph at lines 303--304
[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiFore
[]
-Underfull \hbox (badness 10000) in paragraph at lines 298--299
+Underfull \hbox (badness 10000) in paragraph at lines 304--305
[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiBack at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 299--300
+Underfull \hbox (badness 10000) in paragraph at lines 305--306
[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 7273) in paragraph at lines 301--302
+Underfull \hbox (badness 7273) in paragraph at lines 307--308
[]\T1/ptm/m/n/10 LIGHTWHITE_EX (src.colorama.ansi.AnsiFore at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 308--309
+Underfull \hbox (badness 10000) in paragraph at lines 314--315
[]\T1/ptm/m/n/10 load_cfg_environment()
[]
-Underfull \hbox (badness 10000) in paragraph at lines 308--309
+Underfull \hbox (badness 10000) in paragraph at lines 314--315
\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
[]
-Underfull \hbox (badness 10000) in paragraph at lines 319--320
+Underfull \hbox (badness 10000) in paragraph at lines 325--326
[]\T1/ptm/m/n/10 MAGENTA (src.colorama.winterm.WinColor at-
[]
-Underfull \hbox (badness 10000) in paragraph at lines 354--355
+Underfull \hbox (badness 10000) in paragraph at lines 360--361
[]\T1/ptm/m/n/10 parseKeyValuePair() (src.pyconf.ConfigReader
[]
-Underfull \hbox (badness 10000) in paragraph at lines 356--357
+Underfull \hbox (badness 10000) in paragraph at lines 362--363
[]\T1/ptm/m/n/10 parseMappingBody() (src.pyconf.ConfigReader
[]
[76]
-Underfull \hbox (badness 10000) in paragraph at lines 370--371
+Underfull \hbox (badness 10000) in paragraph at lines 376--377
[]\T1/ptm/m/n/10 prepare_testbase_from_dir() (src.test_module.Test
[]
-Underfull \hbox (badness 10000) in paragraph at lines 371--372
+Underfull \hbox (badness 10000) in paragraph at lines 377--378
[]\T1/ptm/m/n/10 prepare_testbase_from_git() (src.test_module.Test
[]
-Underfull \hbox (badness 10000) in paragraph at lines 372--373
+Underfull \hbox (badness 10000) in paragraph at lines 378--379
[]\T1/ptm/m/n/10 prepare_testbase_from_svn() (src.test_module.Test
[]
-Underfull \hbox (badness 10000) in paragraph at lines 376--377
+Underfull \hbox (badness 10000) in paragraph at lines 382--383
[]\T1/ptm/m/n/10 prepend() (src.fileEnviron.LauncherFileEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 379--380
+Underfull \hbox (badness 10000) in paragraph at lines 385--386
[]\T1/ptm/m/n/10 prepend_value() (src.fileEnviron.ContextFileEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 417--418
+Underfull \hbox (badness 10000) in paragraph at lines 423--424
[]\T1/ptm/m/n/10 put_txt_log_in_appli_log_dir()
[]
-Underfull \hbox (badness 10000) in paragraph at lines 443--444
+Underfull \hbox (badness 10000) in paragraph at lines 449--450
[]\T1/ptm/m/n/10 reset_all() (src.colorama.ansitowin32.AnsiToWin32
[]
-Underfull \hbox (badness 10000) in paragraph at lines 448--449
+Underfull \hbox (badness 10000) in paragraph at lines 454--455
[]\T1/ptm/m/n/10 run_env_script() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 449--450
+Underfull \hbox (badness 10000) in paragraph at lines 455--456
[]\T1/ptm/m/n/10 run_env_script() (src.fileEnviron.ScreenEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 453--454
+Underfull \hbox (badness 10000) in paragraph at lines 459--460
[]\T1/ptm/m/n/10 run_simple_env_script()
[]
-Underfull \hbox (badness 10000) in paragraph at lines 453--454
+Underfull \hbox (badness 10000) in paragraph at lines 459--460
\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
[]
[77]
-Underfull \hbox (badness 10000) in paragraph at lines 475--476
+Underfull \hbox (badness 10000) in paragraph at lines 481--482
[]\T1/ptm/m/n/10 set_a_product() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 478--479
+Underfull \hbox (badness 10000) in paragraph at lines 484--485
[]\T1/ptm/m/n/10 set_console() (src.colorama.winterm.WinTerm
[]
-Underfull \hbox (badness 10000) in paragraph at lines 479--480
+Underfull \hbox (badness 10000) in paragraph at lines 485--486
[]\T1/ptm/m/n/10 set_cpp_env() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 481--482
+Underfull \hbox (badness 10000) in paragraph at lines 487--488
[]\T1/ptm/m/n/10 set_full_environ() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 482--483
+Underfull \hbox (badness 10000) in paragraph at lines 488--489
[]\T1/ptm/m/n/10 set_products() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 6445) in paragraph at lines 483--484
+Underfull \hbox (badness 6445) in paragraph at lines 489--490
[]\T1/ptm/m/n/10 set_python_libdirs() (src.environment.SalomeEnviron
[]
-Underfull \hbox (badness 10000) in paragraph at lines 484--485
+Underfull \hbox (badness 10000) in paragraph at lines 490--491
[]\T1/ptm/m/n/10 set_salome_generic_product_env()
[]
-Underfull \hbox (badness 10000) in paragraph at lines 484--485
+Underfull \hbox (badness 10000) in paragraph at lines 490--491
\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
[]
-Underfull \hbox (badness 10000) in paragraph at lines 485--486
+Underfull \hbox (badness 10000) in paragraph at lines 491--492
[]\T1/ptm/m/n/10 set_salome_minimal_product_env()
[]
-Underfull \hbox (badness 10000) in paragraph at lines 485--486
+Underfull \hbox (badness 10000) in paragraph at lines 491--492
\T1/ptm/m/n/10 (src.environment.SalomeEnviron method),
[]
-Underfull \hbox (badness 10000) in paragraph at lines 488--489
+Underfull \hbox (badness 10000) in paragraph at lines 494--495
[]\T1/ptm/m/n/10 SetConsoleTextAttribute() (in mod-ule
[]
-Overfull \hbox (3.09415pt too wide) in paragraph at lines 492--493
+Overfull \hbox (3.09415pt too wide) in paragraph at lines 498--499
[]\T1/ptm/m/n/10 should_wrap() (src.colorama.ansitowin32.AnsiToWin32
[]
-Underfull \hbox (badness 10000) in paragraph at lines 553--554
+Underfull \hbox (badness 10000) in paragraph at lines 559--560
[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.AnsiToWin32
[]
-Underfull \hbox (badness 10000) in paragraph at lines 554--555
+Underfull \hbox (badness 10000) in paragraph at lines 560--561
[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.StreamWrapper
[]
-Overfull \hbox (25.864pt too wide) in paragraph at lines 559--560
+Overfull \hbox (25.864pt too wide) in paragraph at lines 565--566
[]\T1/ptm/m/n/10 write_and_convert() (src.colorama.ansitowin32.AnsiToWin32
[]
-
-Underfull \hbox (badness 10000) in paragraph at lines 562--563
+[78]
+Underfull \hbox (badness 10000) in paragraph at lines 568--569
[]\T1/ptm/m/n/10 write_env_file() (src.environment.FileEnvWriter
[]
-Overfull \hbox (16.8337pt too wide) in paragraph at lines 563--564
+Overfull \hbox (16.8337pt too wide) in paragraph at lines 569--570
[]\T1/ptm/m/n/10 write_plain_text() (src.colorama.ansitowin32.AnsiToWin32
[]
-[78] [79
+[79
])
-Package atveryend Info: Empty hook `BeforeClearDocument' on input line 7901.
-Package atveryend Info: Empty hook `AfterLastShipout' on input line 7901.
+Package atveryend Info: Empty hook `BeforeClearDocument' on input line 8022.
+Package atveryend Info: Empty hook `AfterLastShipout' on input line 8022.
(./salomeTools.aux)
-Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 7901.
-Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 7901.
+Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 8022.
+Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 8022.
Package rerunfilecheck Info: File `salomeTools.out' has not changed.
-(rerunfilecheck) Checksum: 322546514F02DF4090C0B702DC220115;2961.
-Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 7901.
+(rerunfilecheck) Checksum: C17A5699956F0A7FE0D4242598FFB5FE;3075.
+Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 8022.
)
Here is how much of TeX's memory you used:
- 15028 strings out of 492982
- 234859 string characters out of 6124607
- 345371 words of memory out of 5000000
- 17549 multiletter control sequences out of 15000+600000
+ 15051 strings out of 492982
+ 234938 string characters out of 6124607
+ 346000 words of memory out of 5000000
+ 17564 multiletter control sequences out of 15000+600000
64980 words of font info for 97 fonts, out of 8000000 for 9000
1142 hyphenation exceptions out of 8191
- 37i,12n,45p,550b,631s stack positions out of 5000i,500n,10000p,200000b,80000s
+ 37i,12n,45p,550b,637s 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/public/ams
fonts/cm/cmmi5.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/t
urw/times/utmb8a.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts
/type1/urw/times/utmr8a.pfb></data/tmplgls/wambeke/share/texlive/2017/texmf-dis
t/fonts/type1/urw/times/utmri8a.pfb>
-Output written on salomeTools.pdf (83 pages, 695099 bytes).
+Output written on salomeTools.pdf (83 pages, 695959 bytes).
PDF statistics:
- 1881 PDF objects out of 2073 (max. 8388607)
- 1760 compressed objects within 18 object streams
- 703 named destinations out of 1000 (max. 500000)
- 210 words of extra memory for PDF output out of 10000 (max. 10000000)
+ 1902 PDF objects out of 2073 (max. 8388607)
+ 1781 compressed objects within 18 object streams
+ 713 named destinations out of 1000 (max. 500000)
+ 218 words of extra memory for PDF output out of 10000 (max. 10000000)
\BOOKMARK [1][-]{section.1.2}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n}{chapter.1}% 3
\BOOKMARK [1][-]{section.1.3}{\376\377\000U\000s\000a\000g\000e\000\040\000o\000f\000\040\000S\000A\000l\000o\000m\000e\000T\000o\000o\000l\000s}{chapter.1}% 4
\BOOKMARK [0][-]{chapter.2}{\376\377\000L\000i\000s\000t\000\040\000o\000f\000\040\000C\000o\000m\000m\000a\000n\000d\000s}{}% 5
-\BOOKMARK [1][-]{section.2.1}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000n\000f\000i\000g}{chapter.2}% 6
-\BOOKMARK [1][-]{section.2.2}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000r\000e\000p\000a\000r\000e}{chapter.2}% 7
-\BOOKMARK [1][-]{section.2.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000m\000p\000i\000l\000e}{chapter.2}% 8
-\BOOKMARK [1][-]{section.2.4}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000a\000u\000n\000c\000h\000e\000r}{chapter.2}% 9
-\BOOKMARK [1][-]{section.2.5}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000a\000p\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.2}% 10
-\BOOKMARK [1][-]{section.2.6}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.2}% 11
-\BOOKMARK [1][-]{section.2.7}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000e\000n\000v\000i\000r\000o\000n}{chapter.2}% 12
-\BOOKMARK [1][-]{section.2.8}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000l\000e\000a\000n}{chapter.2}% 13
-\BOOKMARK [1][-]{section.2.9}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000a\000c\000k\000a\000g\000e}{chapter.2}% 14
-\BOOKMARK [1][-]{section.2.10}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000g\000e\000n\000e\000r\000a\000t\000e}{chapter.2}% 15
-\BOOKMARK [0][-]{chapter.3}{\376\377\000D\000e\000v\000e\000l\000o\000p\000e\000r\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 16
-\BOOKMARK [1][-]{section.3.1}{\376\377\000A\000d\000d\000\040\000a\000\040\000u\000s\000e\000r\000\040\000c\000u\000s\000t\000o\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.3}% 17
-\BOOKMARK [0][-]{chapter.4}{\376\377\000C\000o\000d\000e\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 18
-\BOOKMARK [1][-]{section.4.1}{\376\377\000s\000r\000c}{chapter.4}% 19
-\BOOKMARK [0][-]{chapter.5}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000N\000o\000t\000e\000s}{}% 20
-\BOOKMARK [1][-]{section.5.1}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000n\000o\000t\000e\000s}{chapter.5}% 21
-\BOOKMARK [0][-]{section*.532}{\376\377\000P\000y\000t\000h\000o\000n\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 22
-\BOOKMARK [0][-]{section*.533}{\376\377\000I\000n\000d\000e\000x}{}% 23
+\BOOKMARK [1][-]{section.2.1}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000d\000o\000c}{chapter.2}% 6
+\BOOKMARK [1][-]{section.2.2}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000n\000f\000i\000g}{chapter.2}% 7
+\BOOKMARK [1][-]{section.2.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000r\000e\000p\000a\000r\000e}{chapter.2}% 8
+\BOOKMARK [1][-]{section.2.4}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000m\000p\000i\000l\000e}{chapter.2}% 9
+\BOOKMARK [1][-]{section.2.5}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000a\000u\000n\000c\000h\000e\000r}{chapter.2}% 10
+\BOOKMARK [1][-]{section.2.6}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000a\000p\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.2}% 11
+\BOOKMARK [1][-]{section.2.7}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.2}% 12
+\BOOKMARK [1][-]{section.2.8}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000e\000n\000v\000i\000r\000o\000n}{chapter.2}% 13
+\BOOKMARK [1][-]{section.2.9}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000l\000e\000a\000n}{chapter.2}% 14
+\BOOKMARK [1][-]{section.2.10}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000a\000c\000k\000a\000g\000e}{chapter.2}% 15
+\BOOKMARK [1][-]{section.2.11}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000g\000e\000n\000e\000r\000a\000t\000e}{chapter.2}% 16
+\BOOKMARK [0][-]{chapter.3}{\376\377\000D\000e\000v\000e\000l\000o\000p\000e\000r\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 17
+\BOOKMARK [1][-]{section.3.1}{\376\377\000A\000d\000d\000\040\000a\000\040\000u\000s\000e\000r\000\040\000c\000u\000s\000t\000o\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.3}% 18
+\BOOKMARK [0][-]{chapter.4}{\376\377\000C\000o\000d\000e\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 19
+\BOOKMARK [1][-]{section.4.1}{\376\377\000s\000r\000c}{chapter.4}% 20
+\BOOKMARK [0][-]{chapter.5}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000N\000o\000t\000e\000s}{}% 21
+\BOOKMARK [1][-]{section.5.1}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000n\000o\000t\000e\000s}{chapter.5}% 22
+\BOOKMARK [0][-]{section*.538}{\376\377\000P\000y\000t\000h\000o\000n\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 23
+\BOOKMARK [0][-]{section*.539}{\376\377\000I\000n\000d\000e\000x}{}% 24
\title{salomeTools Documentation}
-\date{Apr 25, 2018}
+\date{Jun 19, 2018}
\release{5.0.0dev}
\author{CEA DEN/DANS/DM2S/STMF/LGLS}
\newcommand{\sphinxlogo}{\vbox{}}
\clearpage
+\section{Command doc}
+\label{\detokenize{commands/doc:svn}}\label{\detokenize{commands/doc::doc}}\label{\detokenize{commands/doc:command-doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/doc:description}}
+The \sphinxstylestrong{doc} command displays sat documentation.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/doc:usage}}\begin{itemize}
+\item {}
+Show (in a web browser) the sat documentation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{html}
+\end{sphinxVerbatim}
+
+\item {}
+Show (in evince, for example) the (same) sat documentation in format pdf:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{pdf}
+\end{sphinxVerbatim}
+
+\item {}
+Edit and modify in your preference user editor the sources files (rst) of sat documentation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
+\end{sphinxVerbatim}
+
+\item {}
+get information how to compile locally sat documentation (from the sources files):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{compile}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/doc:some-useful-configuration-pathes}}\begin{itemize}
+\item {}
+\sphinxstylestrong{USER}
+\begin{itemize}
+\item {}
+\sphinxstylestrong{browser} : The browser used to show the html files (\sphinxstyleemphasis{firefox} for example).
+
+\item {}
+\sphinxstylestrong{pdf\_viewer} : The viewer used to show the pdf files (\sphinxstyleemphasis{evince} for example).
+
+\item {}
+\sphinxstylestrong{editor} : The editor used to edit ascii text files (\sphinxstyleemphasis{pluma or gedit} for example).
+
+\end{itemize}
+
+\end{itemize}
+
+\clearpage
+
+
\section{Command config}
\label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}}
\section{src}
\label{\detokenize{commands/apidoc/modules:src}}\label{\detokenize{commands/apidoc/modules::doc}}
-\subsection{src Package}
+\subsection{src package}
\label{\detokenize{commands/apidoc/src::doc}}\label{\detokenize{commands/apidoc/src:src-package}}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{src}} Package}
-\label{\detokenize{commands/apidoc/src:id1}}\phantomsection\label{\detokenize{commands/apidoc/src:module-src.__init__}}\index{src.\_\_init\_\_ (module)}
-initial imports and utilities methods for salomeTools
-\index{Path (class in src.\_\_init\_\_)}
+\subsubsection{Subpackages}
+\label{\detokenize{commands/apidoc/src:subpackages}}
+
+\paragraph{src.colorama package}
+\label{\detokenize{commands/apidoc/src.colorama:src-colorama-package}}\label{\detokenize{commands/apidoc/src.colorama::doc}}
+
+\subparagraph{Submodules}
+\label{\detokenize{commands/apidoc/src.colorama:submodules}}
+
+\subparagraph{src.colorama.ansi module}
+\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansi}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-ansi-module}}\index{src.colorama.ansi (module)}
+This module generates ANSI character codes to printing colors to terminals.
+See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
+\index{AnsiBack (class in src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{Path}}}{\emph{path}}{}~\index{base() (src.\_\_init\_\_.Path method)}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}}
+Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BLACK (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
\end{fulllineitems}
-\index{chmod() (src.\_\_init\_\_.Path method)}
+\index{BLUE (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
\end{fulllineitems}
-\index{copy() (src.\_\_init\_\_.Path method)}
+\index{CYAN (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
\end{fulllineitems}
-\index{copydir() (src.\_\_init\_\_.Path method)}
+\index{GREEN (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
\end{fulllineitems}
-\index{copyfile() (src.\_\_init\_\_.Path method)}
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
\end{fulllineitems}
-\index{copylink() (src.\_\_init\_\_.Path method)}
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
\end{fulllineitems}
-\index{dir() (src.\_\_init\_\_.Path method)}
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}}
\end{fulllineitems}
-\index{exists() (src.\_\_init\_\_.Path method)}
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}}
\end{fulllineitems}
-\index{isdir() (src.\_\_init\_\_.Path method)}
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
\end{fulllineitems}
-\index{isfile() (src.\_\_init\_\_.Path method)}
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}}
\end{fulllineitems}
-\index{islink() (src.\_\_init\_\_.Path method)}
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}}
\end{fulllineitems}
-\index{list() (src.\_\_init\_\_.Path method)}
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}}
\end{fulllineitems}
-\index{make() (src.\_\_init\_\_.Path method)}
+\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
\end{fulllineitems}
-\index{readlink() (src.\_\_init\_\_.Path method)}
+\index{RED (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
\end{fulllineitems}
-\index{rm() (src.\_\_init\_\_.Path method)}
+\index{RESET (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
\end{fulllineitems}
-\index{smartcopy() (src.\_\_init\_\_.Path method)}
+\index{WHITE (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
\end{fulllineitems}
-\index{symlink() (src.\_\_init\_\_.Path method)}
+\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
\end{fulllineitems}
\end{fulllineitems}
-\index{SatException}
+\index{AnsiCodes (class in src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{SatException}}}
-Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
-
-rename Exception Class
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
\end{fulllineitems}
-\index{activate\_mesa\_property() (in module src.\_\_init\_\_)}
+\index{AnsiCursor (class in src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{}
-Add mesa property into application properties
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application!
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BACK() (src.colorama.ansi.AnsiCursor method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{DOWN() (src.colorama.ansi.AnsiCursor method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
\end{fulllineitems}
-\index{check\_config\_has\_application() (in module src.\_\_init\_\_)}
+\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.check_config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{POS() (src.colorama.ansi.AnsiCursor method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{}
\end{fulllineitems}
-\index{check\_config\_has\_profile() (in module src.\_\_init\_\_)}
+\index{UP() (src.colorama.ansi.AnsiCursor method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.check_config_has_profile}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{config\_has\_application() (in module src.\_\_init\_\_)}
+\index{AnsiFore (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}}
+Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BLACK (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
\end{fulllineitems}
-\index{deepcopy\_list() (in module src.\_\_init\_\_)}
+\index{BLUE (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
-Do a deep copy of a list
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The copy of the list
+\index{CYAN (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-List
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{GREEN (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
\end{fulllineitems}
-\index{ensure\_path\_exists() (in module src.\_\_init\_\_)}
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{}
-Create a path if not existing
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
\end{fulllineitems}
-\index{find\_file\_in\_lpath() (in module src.\_\_init\_\_)}
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.find_file_in_lpath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
+\end{fulllineitems}
-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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the additional directory
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-the full path of the file or False if not found
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
\end{fulllineitems}
-\index{get\_base\_path() (in module src.\_\_init\_\_)}
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
-Returns the path of the products base.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The path of the products base.
+\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{RED (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
\end{fulllineitems}
-\index{get\_cfg\_param() (in module src.\_\_init\_\_)}
+\index{RESET (src.colorama.ansi.AnsiFore attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_cfg_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The value to return if param\_name is not in config
+\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-see initial description of the function
+\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_launcher\_name() (in module src.\_\_init\_\_)}
+\index{AnsiStyle (class in src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
-Returns the name of salome launcher.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
-
-\item[{Returns}] \leavevmode
-The name of salome launcher.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}}
+Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
\end{fulllineitems}
-\index{get\_log\_path() (in module src.\_\_init\_\_)}
+\index{DIM (src.colorama.ansi.AnsiStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
-Returns the path of the logs.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
-
-\item[{Returns}] \leavevmode
-The path of the logs.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}
-\index{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)}
+\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_property_in_product_cfg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_property\_in\_product\_cfg}}}{\emph{product\_cfg}, \emph{pprty}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
\end{fulllineitems}
-\index{get\_salome\_version() (in module src.\_\_init\_\_)}
+\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}
-\index{get\_tmp\_filename() (in module src.\_\_init\_\_)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{}
\end{fulllineitems}
-\index{handleRemoveReadonly() (in module src.\_\_init\_\_)}
+\index{clear\_line() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_line}}}{\emph{mode=2}}{}
\end{fulllineitems}
-\index{merge\_dicts() (in module src.\_\_init\_\_)}
+\index{clear\_screen() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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.
-
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_screen}}}{\emph{mode=2}}{}
\end{fulllineitems}
-\index{only\_numbers() (in module src.\_\_init\_\_)}
+\index{code\_to\_chars() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{code\_to\_chars}}}{\emph{code}}{}
\end{fulllineitems}
-\index{parse\_date() (in module src.\_\_init\_\_)}
+\index{set\_title() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
-Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date to transform
-
-\item[{Returns}] \leavevmode
-The date in the new format
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
\end{fulllineitems}
-\index{print\_info() (in module src.\_\_init\_\_)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display
+\subparagraph{src.colorama.ansitowin32 module}
+\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-ansitowin32-module}}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{AnsiToWin32}}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\end{description}\end{quote}
+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{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_CSI\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}
-\index{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)}
+\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.read_config_from_a_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{read\_config\_from\_a\_file}}}{\emph{filePath}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_OSC\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}
-\index{remove\_item\_from\_list() (in module src.\_\_init\_\_)}
+\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.remove_item_from_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{remove\_item\_from\_list}}}{\emph{input\_list}, \emph{item}}{}
-Remove all occurences of item from input\_list
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to modify
-
-\item[{Returns}] \leavevmode
-The without any item
-
-\item[{Return type}] \leavevmode
-List
-
-\end{description}\end{quote}
-
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{}
\end{fulllineitems}
-\index{replace\_in\_file() (in module src.\_\_init\_\_)}
+\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.replace_in_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{replace\_in\_file}}}{\emph{filein}, \emph{strin}, \emph{strout}}{}
-Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
-
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
\end{fulllineitems}
+\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
+\end{fulllineitems}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{ElementTree}} Module}
-\label{\detokenize{commands/apidoc/src:elementtree-module}}\label{\detokenize{commands/apidoc/src:module-src.ElementTree}}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}
+\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{}
\end{fulllineitems}
-\index{dump() (in module src.ElementTree)}
+\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
\end{fulllineitems}
-\index{Element() (in module src.ElementTree)}
+\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
\end{fulllineitems}
-\index{ElementTree (class in src.ElementTree)}
+\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ElementTree}}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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()
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
\end{fulllineitems}
-\index{findall() (src.ElementTree.ElementTree method)}
+\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
\end{fulllineitems}
-\index{findtext() (src.ElementTree.ElementTree method)}
+\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{getiterator() (src.ElementTree.ElementTree method)}
+\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_plain\_text}}}{\emph{text}, \emph{start}, \emph{end}}{}
\end{fulllineitems}
-\index{getroot() (src.ElementTree.ElementTree method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
\end{fulllineitems}
-\index{parse() (src.ElementTree.ElementTree method)}
+\index{StreamWrapper (class in src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{StreamWrapper}}}{\emph{wrapped}, \emph{converter}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\index{write() (src.ElementTree.ElementTree method)}
+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{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
\end{fulllineitems}
\end{fulllineitems}
-\index{fromstring() (in module src.ElementTree)}
+\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_a\_tty}}}{\emph{stream}}{}
\end{fulllineitems}
-\index{iselement() (in module src.ElementTree)}
+\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_stream\_closed}}}{\emph{stream}}{}
\end{fulllineitems}
-\index{iterparse (class in src.ElementTree)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iterparse}}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}
+
+\subparagraph{src.colorama.initialise module}
+\label{\detokenize{commands/apidoc/src.colorama:src-colorama-initialise-module}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{colorama\_text}}}{\emph{*args}, \emph{**kwds}}{}
\end{fulllineitems}
+\index{deinit() (in module src.colorama.initialise)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{}
\end{fulllineitems}
-\index{parse() (in module src.ElementTree)}
+\index{init() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.init}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{init}}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
\end{fulllineitems}
-\index{PI() (in module src.ElementTree)}
+\index{reinit() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
\end{fulllineitems}
-\index{ProcessingInstruction() (in module src.ElementTree)}
+\index{reset\_all() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
\end{fulllineitems}
-\index{QName (class in src.ElementTree)}
+\index{wrap\_stream() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.QName}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{QName}}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{wrap\_stream}}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
\end{fulllineitems}
-\index{SubElement() (in module src.ElementTree)}
+
+
+\subparagraph{src.colorama.win32 module}
+\label{\detokenize{commands/apidoc/src.colorama:src-colorama-win32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.win32}}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
\end{fulllineitems}
-\index{tostring() (in module src.ElementTree)}
+\index{winapi\_test() (in module src.colorama.win32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
\end{fulllineitems}
-\index{TreeBuilder (class in src.ElementTree)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{TreeBuilder}}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
-\end{fulllineitems}
+\subparagraph{src.colorama.winterm module}
+\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.winterm}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-winterm-module}}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}
-\index{data() (src.ElementTree.TreeBuilder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BLACK (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}
-\index{end() (src.ElementTree.TreeBuilder method)}
+\index{BLUE (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}}
\end{fulllineitems}
-\index{start() (src.ElementTree.TreeBuilder method)}
+\index{CYAN (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
\end{fulllineitems}
+\index{GREEN (src.colorama.winterm.WinColor attribute)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}
-\index{XML() (in module src.ElementTree)}
+\index{GREY (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
\end{fulllineitems}
-\index{XMLTreeBuilder (class in src.ElementTree)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XMLTreeBuilder}}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)}
+\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
\end{fulllineitems}
-\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
+\index{RED (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
\end{fulllineitems}
-\index{feed() (src.ElementTree.XMLTreeBuilder method)}
+\index{YELLOW (src.colorama.winterm.WinColor attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}}
\end{fulllineitems}
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{architecture}} Module}
-\label{\detokenize{commands/apidoc/src:architecture-module}}\label{\detokenize{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)}
+\index{WinStyle (class in src.colorama.winterm)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distrib_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distrib\_version}}}{\emph{distrib}, \emph{codes}}{}
-Gets the version of the distribution
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{distrib}}) \textendash{} The distribution on which the version will be found.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}}
+\end{fulllineitems}
-\end{itemize}
+\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
-\item[{Returns}] \leavevmode
-The version of the distribution on which salomeTools is running,
-regarding the distribution correlation table contained in codes
-variable.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}}
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-str
+\index{NORMAL (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_distribution() (in module src.architecture)}
+\index{WinTerm (class in src.colorama.winterm)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{}
-Gets the code for the distribution
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{back() (src.colorama.winterm.WinTerm method)}
-\item[{Returns}] \leavevmode
-The distribution on which salomeTools is running, regarding the
-distribution correlation table contained in codes variable.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{back}}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-str
+\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cursor\_adjust}}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{erase\_line() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_line}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{get\_nb\_proc() (in module src.architecture)}
+\index{erase\_screen() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}~\begin{description}
-\item[{Gets the number of processors of the machine }] \leavevmode
-on which salomeTools is running.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_screen}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
-\end{description}
-\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-the number of processors.
+\index{fore() (src.colorama.winterm.WinTerm method)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{fore}}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
\end{fulllineitems}
-\index{get\_python\_version() (in module src.architecture)}
+\index{get\_position() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{}
-Gets the version of the running python.
-\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-the version of the running python.
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-str
+\index{reset\_all() (src.colorama.winterm.WinTerm method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{}
+\end{fulllineitems}
+
+\index{set\_attrs() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
\end{fulllineitems}
-\index{get\_user() (in module src.architecture)}
+\index{set\_console() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{}
-method that gets the username that launched sat
-\begin{quote}\begin{description}
-\item[{Return type}] \leavevmode
-str
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_console}}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cursor\_position}}}{\emph{position=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{is\_windows() (in module src.architecture)}
+\index{set\_title() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{}
-method that checks windows OS
-\begin{quote}\begin{description}
-\item[{Return type}] \leavevmode
-boolean
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{style() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
+\end{fulllineitems}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{compilation}} Module}
-\label{\detokenize{commands/apidoc/src:module-src.compilation}}\label{\detokenize{commands/apidoc/src:compilation-module}}\index{src.compilation (module)}\index{Builder (class in src.compilation)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.compilation.}}\sphinxbfcode{\sphinxupquote{Builder}}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=\textless{}src.options.OptResult object at 0x37b8f90\textgreater{}}, \emph{check\_src=True}}{}
-Class to handle all construction steps, like cmake, configure, make, …
-\index{build\_configure() (src.compilation.Builder method)}
+
+\subparagraph{Module contents}
+\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama}}\label{\detokenize{commands/apidoc/src.colorama:module-contents}}\index{src.colorama (module)}
+
+\subsubsection{Submodules}
+\label{\detokenize{commands/apidoc/src:submodules}}
+
+\subsubsection{src.ElementTree module}
+\label{\detokenize{commands/apidoc/src:src-elementtree-module}}\label{\detokenize{commands/apidoc/src:module-src.ElementTree}}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
\end{fulllineitems}
-\index{check() (src.compilation.Builder method)}
+\index{dump() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
\end{fulllineitems}
-\index{cmake() (src.compilation.Builder method)}
+\index{Element() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}
-\index{complete\_environment() (src.compilation.Builder method)}
+\index{ElementTree (class in src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ElementTree}}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
\end{fulllineitems}
-\index{configure() (src.compilation.Builder method)}
+\index{findall() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
\end{fulllineitems}
-\index{do\_batch\_script\_build() (src.compilation.Builder method)}
+\index{findtext() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_batch\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
\end{fulllineitems}
-\index{do\_default\_build() (src.compilation.Builder method)}
+\index{getiterator() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_default_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_default\_build}}}{\emph{build\_conf\_options=''}, \emph{configure\_options=''}, \emph{show\_warning=True}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{}
\end{fulllineitems}
-\index{do\_python\_script\_build() (src.compilation.Builder method)}
+\index{getroot() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_python_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_python\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
\end{fulllineitems}
-\index{do\_script\_build() (src.compilation.Builder method)}
+\index{parse() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_script\_build}}}{\emph{script}, \emph{number\_of\_proc=0}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
\end{fulllineitems}
-\index{hack\_libtool() (src.compilation.Builder method)}
+\index{write() (src.ElementTree.ElementTree method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{}
\end{fulllineitems}
-\index{install() (src.compilation.Builder method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
\end{fulllineitems}
-\index{log() (src.compilation.Builder method)}
+\index{fromstring() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
\end{fulllineitems}
-\index{log\_command() (src.compilation.Builder method)}
+\index{iselement() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
\end{fulllineitems}
-\index{make() (src.compilation.Builder method)}
+\index{iterparse (class in src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iterparse}}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}
-\index{prepare() (src.compilation.Builder method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
\end{fulllineitems}
-\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
+\index{parse() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_txt\_log\_in\_appli\_log\_dir}}}{\emph{file\_name}}{}~\begin{description}
-\item[{Put the txt log (that contain the system logs, like make command}] \leavevmode
-output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
-\end{description}
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write
+\index{PI() (in module src.ElementTree)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
+
+\index{ProcessingInstruction() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{}
\end{fulllineitems}
-\index{wmake() (src.compilation.Builder method)}
+\index{QName (class in src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.QName}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{QName}}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
\end{fulllineitems}
+\index{SubElement() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}
+\index{tostring() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{}
+\end{fulllineitems}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{debug}} Module}
-\label{\detokenize{commands/apidoc/src:module-src.debug}}\label{\detokenize{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
+\index{TreeBuilder (class in src.ElementTree)}
-\item {}
-show pretty print debug representation from instances of SAT classes
-(pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{TreeBuilder}}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
-WARNING: obviously supposedly show messages in SAT development phase, not production
+\index{data() (src.ElementTree.TreeBuilder method)}
-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)
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
+\end{fulllineitems}
-to set show message as development phase:
-\textgreater{}\textgreater{} DBG.push\_debug(True)
+\index{end() (src.ElementTree.TreeBuilder method)}
-to set no show message as production phase:
-\textgreater{}\textgreater{} DBG.push\_debug(False)
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
+\end{fulllineitems}
-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{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
-Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
-
-utility class for pyconf.Config input iostream
-
-\end{fulllineitems}
-
-\index{OutStream (class in src.debug)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
-Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
-
-utility class for pyconf.Config output iostream
-\index{close() (src.debug.OutStream method)}
+\index{start() (src.ElementTree.TreeBuilder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
-because Config.\_\_save\_\_ calls close() stream as file
-keep value before lost as self.value
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
\end{fulllineitems}
\end{fulllineitems}
-\index{getLocalEnv() (in module src.debug)}
+\index{XML() (in module src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
-get string for environment variables representation
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
\end{fulllineitems}
-\index{getStrConfigDbg() (in module src.debug)}
+\index{XMLTreeBuilder (class in src.ElementTree)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
-set string as saveConfigDbg,
-as (path expression evaluation) for debug
-
-\end{fulllineitems}
-
-\index{getStrConfigStd() (in module src.debug)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XMLTreeBuilder}}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
-set string as saveConfigStd, as file .pyconf
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}
-\index{indent() (in module src.debug)}
+\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
-indent multi lines message
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
\end{fulllineitems}
-\index{pop\_debug() (in module src.debug)}
+\index{feed() (src.ElementTree.XMLTreeBuilder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
-restore previous debug outputs status
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
\end{fulllineitems}
-\index{push\_debug() (in module src.debug)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
-set debug outputs activated, or not
\end{fulllineitems}
-\index{saveConfigDbg() (in module src.debug)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{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)}
+\subsubsection{src.architecture module}
+\label{\detokenize{commands/apidoc/src:module-src.architecture}}\label{\detokenize{commands/apidoc/src:src-architecture-module}}\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{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
-returns as file .pyconf
-
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distrib_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distrib\_version}}}{\emph{distrib}, \emph{codes}}{}
+Gets the version of the distribution
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{distrib}}) \textendash{} The distribution on which the version will be found.
-\index{tofix() (in module src.debug)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{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{itemize}
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+The version of the distribution on which salomeTools is running,
+regarding the distribution correlation table contained in codes
+variable.
-\index{write() (in module src.debug)}
+\item[{Return type}] \leavevmode
+str
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.write}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{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{description}\end{quote}
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{environment}} Module}
-\label{\detokenize{commands/apidoc/src:environment-module}}\label{\detokenize{commands/apidoc/src:module-src.environment}}\index{src.environment (module)}\index{Environ (class in src.environment)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
-Class to manage the environment context
-\index{append() (src.environment.Environ method)}
+\index{get\_distribution() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-Same as append\_value but the value argument can be a list
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{}
+Gets the code for the distribution
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\item[{Returns}] \leavevmode
+The distribution on which salomeTools is running, regarding the
+distribution correlation table contained in codes variable.
-\end{itemize}
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{append\_value() (src.environment.Environ method)}
+\index{get\_nb\_proc() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-append value to key using sep
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}~\begin{description}
+\item[{Gets the number of processors of the machine }] \leavevmode
+on which salomeTools is running.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\end{description}
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+the number of processors.
-\end{itemize}
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{command\_value() (src.environment.Environ method)}
+\index{get\_python\_version() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
-Get the value given by the system command “command”
-and put it in the environment variable key
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{}
+Gets the version of the running python.
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\item[{Returns}] \leavevmode
+the version of the running python.
-\end{itemize}
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{get() (src.environment.Environ method)}
+\index{get\_user() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{}
+method that gets the username that launched sat
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.environment.Environ method)}
+\index{is\_windows() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
-Check if the key exists in the environment
+\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{}
+method that checks windows OS
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
+\item[{Return type}] \leavevmode
+boolean
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend() (src.environment.Environ method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+\subsubsection{src.compilation module}
+\label{\detokenize{commands/apidoc/src:module-src.compilation}}\label{\detokenize{commands/apidoc/src:src-compilation-module}}\index{src.compilation (module)}\index{Builder (class in src.compilation)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.compilation.}}\sphinxbfcode{\sphinxupquote{Builder}}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=OptResult( )}, \emph{check\_src=True}}{}
+Class to handle all construction steps, like cmake, configure, make, …
+\index{build\_configure() (src.compilation.Builder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{check() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
\end{fulllineitems}
-\index{prepend\_value() (src.environment.Environ method)}
+\index{cmake() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-prepend value to key using sep
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\index{complete\_environment() (src.compilation.Builder method)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
+\end{fulllineitems}
-\end{itemize}
+\index{configure() (src.compilation.Builder method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{}
+\end{fulllineitems}
+
+\index{do\_batch\_script\_build() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_batch\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
\end{fulllineitems}
-\index{set() (src.environment.Environ method)}
+\index{do\_default\_build() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_default_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.compilation.Builder.do_python_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_python\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
\end{fulllineitems}
-\index{FileEnvWriter (class in src.environment)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{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)}
+\index{do\_script\_build() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables
-to add to the environment
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment
-designed for a package.
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_script\_build}}}{\emph{script}, \emph{number\_of\_proc=0}}{}
\end{fulllineitems}
-\index{write\_env\_file() (src.environment.FileEnvWriter method)}
+\index{hack\_libtool() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat)
-
-\end{itemize}
-
-\item[{Returns}] \leavevmode
-The path to the generated file
-
-\item[{Return type}] \leavevmode
-str
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{install() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
\end{fulllineitems}
+\index{log() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
\end{fulllineitems}
-\index{SalomeEnviron (class in src.environment)}
+\index{log\_command() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{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)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
+\end{fulllineitems}
+
+\index{make() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
-Add a commentary to the out stream (in case of file generation)
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{prepare() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
\end{fulllineitems}
-\index{add\_line() (src.environment.SalomeEnviron method)}
+\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
-Add empty lines to the out stream (in case of file generation)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_txt\_log\_in\_appli\_log\_dir}}}{\emph{file\_name}}{}~\begin{description}
+\item[{Put the txt log (that contain the system logs, like make command}] \leavevmode
+output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add
+\sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.environment.SalomeEnviron method)}
+\index{wmake() (src.compilation.Builder method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
-Add a warning to the out stream (in case of file generation)
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add
+\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{append() (src.environment.SalomeEnviron method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-append value to key using sep
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
+\subsubsection{src.debug module}
+\label{\detokenize{commands/apidoc/src:module-src.debug}}\label{\detokenize{commands/apidoc/src:src-debug-module}}\index{src.debug (module)}
+This file assume DEBUG functionalities use
+\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+print debug messages in sys.stderr for salomeTools
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)
\end{itemize}
-\end{description}\end{quote}
+WARNING: obviously supposedly show messages in SAT development phase, not production
-\end{fulllineitems}
+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)
-\index{dump() (src.environment.SalomeEnviron method)}
+to set show message as development phase:
+\textgreater{}\textgreater{} DBG.push\_debug(True)
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
-Write the environment to out
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment
+to set no show message as production phase:
+\textgreater{}\textgreater{} DBG.push\_debug(False)
-\end{description}\end{quote}
+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
-\end{fulllineitems}
+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
-\index{finish() (src.environment.SalomeEnviron method)}
+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{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
-Add a final instruction in the out file (in case of file generation)
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
+Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
-\end{description}\end{quote}
+utility class for pyconf.Config input iostream
\end{fulllineitems}
-\index{get() (src.environment.SalomeEnviron method)}
+\index{OutStream (class in src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
+Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
-\end{description}\end{quote}
+utility class for pyconf.Config output iostream
+\index{close() (src.debug.OutStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+because Config.\_\_save\_\_ calls close() stream as file
+keep value before lost as self.value
\end{fulllineitems}
-\index{get\_names() (src.environment.SalomeEnviron method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{getLocalEnv() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
+get string for environment variables representation
\end{fulllineitems}
-\index{is\_defined() (src.environment.SalomeEnviron method)}
+\index{getStrConfigDbg() (in module src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
-Check if the key exists in the environment
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
-
-\end{description}\end{quote}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
+set string as saveConfigDbg,
+as (path expression evaluation) for debug
\end{fulllineitems}
-\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
+\index{getStrConfigStd() (in module src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
-Loads environment defined in cfg\_env
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment
-
-\end{description}\end{quote}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
+set string as saveConfigStd, as file .pyconf
\end{fulllineitems}
-\index{prepend() (src.environment.SalomeEnviron method)}
+\index{indent() (in module src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-prepend value to key using sep
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
+indent multi lines message
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\end{fulllineitems}
-\end{itemize}
+\index{pop\_debug() (in module src.debug)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
+restore previous debug outputs status
\end{fulllineitems}
-\index{run\_env\_script() (src.environment.SalomeEnviron method)}
+\index{push\_debug() (in module src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
+set debug outputs activated, or not
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env
+\index{saveConfigDbg() (in module src.debug)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigDbg}}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path=''}}{}
+pyconf returns multilines (path expression evaluation) for debug
-\end{description}\end{quote}
+\end{fulllineitems}
+
+\index{saveConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
+returns as file .pyconf
\end{fulllineitems}
-\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
+\index{tofix() (in module src.debug)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.debug.write}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{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{src.environment module}
+\label{\detokenize{commands/apidoc/src:src-environment-module}}\label{\detokenize{commands/apidoc/src:module-src.environment}}\index{src.environment (module)}\index{Environ (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
+Class to manage the environment context
+\index{append() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{set() (src.environment.SalomeEnviron method)}
+\index{append\_value() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{set\_a\_product() (src.environment.SalomeEnviron method)}
+\index{command\_value() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
-Sets the environment of a product.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
\end{itemize}
\end{fulllineitems}
-\index{set\_application\_env() (src.environment.SalomeEnviron method)}
+\index{get() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
-Sets the environment defined in the APPLICATION file.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
+\index{is\_defined() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
-Sets the generic environment for a SALOME cpp product.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
+\index{prepend() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{}
-Sets the full environment for products
-specified in env\_info dictionary.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{set\_products() (src.environment.SalomeEnviron method)}
+\index{prepend\_value() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
-Sets the environment for all the products.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory
-
-\end{itemize}
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{}
-Set some generic variables for python library paths
-
-\end{fulllineitems}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
-\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
-Sets the generic environment for a SALOME product.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
+\index{set() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
\end{itemize}
\end{fulllineitems}
-\index{Shell (class in src.environment)}
+\index{FileEnvWriter (class in src.environment)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
-Definition of a Shell.
-
-\end{fulllineitems}
-
-\index{load\_environment() (in module src.environment)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.environment.load_environment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{load\_environment}}}{\emph{config}, \emph{build}, \emph{logger}}{}
-Loads the environment (used to run the tests, for example).
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True
+\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables
+to add to the environment
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment
+designed for a package.
\end{itemize}
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{fileEnviron}} Module}
-\label{\detokenize{commands/apidoc/src:fileenviron-module}}\label{\detokenize{commands/apidoc/src:module-src.fileEnviron}}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BashFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
-
-Class for bash shell.
-\index{command\_value() (src.fileEnviron.BashFileEnviron method)}
+\index{write\_env\_file() (src.environment.FileEnvWriter method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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}
-\index{finish() (src.fileEnviron.BashFileEnviron method)}
+
+\end{fulllineitems}
+
+\index{SalomeEnviron (class in src.environment)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
-Add a final instruction in the out file (in case of file generation)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a commentary to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.BashFileEnviron method)}
+\index{add\_line() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
+Add empty lines to the out stream (in case of file generation)
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add
\end{description}\end{quote}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{BatFileEnviron (class in src.fileEnviron)}
+\index{add\_warning() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BatFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
-
-for Windows batch shell.
-\index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
-Add a comment in the shell file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
+\index{append() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.BatFileEnviron method)}
+\index{dump() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
-Add a final instruction in the out file (in case of file generation)
-In the particular windows case, do nothing
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
+Write the environment to out
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment
\end{description}\end{quote}
\end{fulllineitems}
-\index{get() (src.fileEnviron.BatFileEnviron method)}
+\index{finish() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
+Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.BatFileEnviron method)}
+\index{get() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
\end{description}\end{quote}
\end{fulllineitems}
+\index{get\_names() (src.environment.SalomeEnviron method)}
-\end{fulllineitems}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add
-\index{ContextFileEnviron (class in src.fileEnviron)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ContextFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
+\end{fulllineitems}
-Class for a salome context configuration file.
-\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
+\index{is\_defined() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
-Add a comment
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
+\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
-Add a warning
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
+Loads environment defined in cfg\_env
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment
\end{description}\end{quote}
\end{fulllineitems}
-\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{prepend() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-append value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
\item {}
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{run\_env\_script() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env
\end{itemize}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.ContextFileEnviron method)}
+\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
-Add a final instruction in the out file (in case of file generation)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script
-\index{get() (src.fileEnviron.ContextFileEnviron method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{set() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-prepend value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
\end{itemize}
\end{fulllineitems}
-\index{set() (src.fileEnviron.ContextFileEnviron method)}
+\index{set\_a\_product() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
+Sets the environment of a product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
\end{itemize}
\end{fulllineitems}
+\index{set\_application\_env() (src.environment.SalomeEnviron method)}
-\end{fulllineitems}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
+Sets the environment defined in the APPLICATION file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
-\index{FileEnviron (class in src.fileEnviron)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{FileEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\end{fulllineitems}
-Base class for shell environment
-\index{add\_comment() (src.fileEnviron.FileEnviron method)}
+\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
-Add a comment in the shell file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
+Sets the generic environment for a SALOME cpp product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_echo() (src.fileEnviron.FileEnviron method)}
+\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
-Add a “echo” in the shell file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_line() (src.fileEnviron.FileEnviron method)}
+\index{set\_products() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
-Add some empty lines in the shell file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
+Sets the environment for all the products.
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.FileEnviron method)}
+\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
-Add a warning “echo” in the shell file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
+Sets the generic environment for a SALOME product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description
\end{description}\end{quote}
\end{fulllineitems}
-\index{append() (src.fileEnviron.FileEnviron method)}
+\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-Same as append\_value but the value argument can be a list
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
\end{itemize}
\end{fulllineitems}
-\index{append\_value() (src.fileEnviron.FileEnviron method)}
+
+\end{fulllineitems}
+
+\index{Shell (class in src.environment)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-append value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
+Definition of a Shell.
+
+\end{fulllineitems}
+
+\index{load\_environment() (in module src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.load_environment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
\end{itemize}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.FileEnviron method)}
+
+
+\subsubsection{src.fileEnviron module}
+\label{\detokenize{commands/apidoc/src:src-fileenviron-module}}\label{\detokenize{commands/apidoc/src:module-src.fileEnviron}}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BashFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
+
+Class for bash shell.
+\index{command\_value() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
\end{fulllineitems}
-\index{finish() (src.fileEnviron.FileEnviron method)}
+\index{finish() (src.fileEnviron.BashFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{get() (src.fileEnviron.FileEnviron method)}
+\index{set() (src.fileEnviron.BashFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.FileEnviron method)}
+
+\end{fulllineitems}
+
+\index{BatFileEnviron (class in src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
-Check if the key exists in the environment
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BatFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
+
+for Windows batch shell.
+\index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend() (src.fileEnviron.FileEnviron method)}
+\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-Same as prepend\_value but the value argument can be a list
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
\end{itemize}
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
+\index{finish() (src.fileEnviron.BatFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-prepend value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.FileEnviron method)}
+\index{get() (src.fileEnviron.BatFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable ‘key’ to value ‘value’
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{LauncherFileEnviron (class in src.fileEnviron)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{LauncherFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Class to generate a launcher file script
-(in python syntax) SalomeContext API
-\index{add() (src.fileEnviron.LauncherFileEnviron method)}
+\index{set() (src.fileEnviron.BatFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
-prepend value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
\end{itemize}
\end{fulllineitems}
-\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
\end{fulllineitems}
-\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
+\index{ContextFileEnviron (class in src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
-Add a comment
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ContextFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
-\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
+Class for a salome context configuration file.
+\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
-Add some empty lines in the launcher file
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a comment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
+\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{append() (src.fileEnviron.LauncherFileEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
-
-\end{itemize}
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\end{fulllineitems}
-\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
-\end{fulllineitems}
-
-\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
+\index{finish() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
\end{fulllineitems}
-\index{get() (src.fileEnviron.LauncherFileEnviron method)}
+\index{get() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
-Check if the key exists in the environment
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
+\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-Same as prepend\_value but the value argument can be a list
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
\item {}
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{set() (src.fileEnviron.ContextFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
-prepend value to key using sep
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
-
-\end{itemize}
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{set() (src.fileEnviron.LauncherFileEnviron method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
-Set the environment variable “key” to value “value”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
\end{itemize}
\end{fulllineitems}
-\index{ScreenEnviron (class in src.fileEnviron)}
+\index{FileEnviron (class in src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ScreenEnviron}}}{\emph{output}, \emph{environ=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
-\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{FileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Base class for shell environment
+\index{add\_comment() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
+\index{add\_echo() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
Add a “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
+\index{add\_line() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
Add some empty lines in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
+\index{add\_warning() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{append() (src.fileEnviron.ScreenEnviron method)}
+\index{append() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
+\index{append\_value() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
\end{fulllineitems}
-\index{get() (src.fileEnviron.ScreenEnviron method)}
+\index{finish() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
+\index{is\_defined() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\end{fulllineitems}
-\index{prepend() (src.fileEnviron.ScreenEnviron method)}
+\index{prepend() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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}
\end{fulllineitems}
-\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
+\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{set() (src.fileEnviron.ScreenEnviron method)}
+\index{set() (src.fileEnviron.FileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable ‘key’ to value ‘value’
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\end{fulllineitems}
-\index{write() (src.fileEnviron.ScreenEnviron method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
\end{fulllineitems}
+\index{LauncherFileEnviron (class in src.fileEnviron)}
-\end{fulllineitems}
-
-\index{get\_file\_environ() (in module src.fileEnviron)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.fileEnviron.get_file_environ}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{get\_file\_environ}}}{\emph{output}, \emph{shell}, \emph{environ=None}}{}
-Instantiate correct FileEnvironment sub-class.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
\end{itemize}
\end{fulllineitems}
-\index{special\_path\_separator() (in module src.fileEnviron)}
+\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a comment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
\end{description}\end{quote}
\end{fulllineitems}
+\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+Add some empty lines in the launcher file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{fork}} Module}
-\label{\detokenize{commands/apidoc/src:fork-module}}\label{\detokenize{commands/apidoc/src:module-src.fork}}\index{src.fork (module)}\index{batch() (in module src.fork)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
\end{fulllineitems}
-\index{batch\_salome() (in module src.fork)}
+\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{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}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
-\index{launch\_command() (in module src.fork)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.launch_command}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{launch\_command}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{}
\end{fulllineitems}
-\index{show\_progress() (in module src.fork)}
+\index{append() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.show_progress}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{show\_progress}}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss=''}}{}
-shortcut function to display the progression
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{write\_back() (in module src.fork)}
+\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.write_back}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{write\_back}}}{\emph{logger}, \emph{message}, \emph{level}}{}
-shortcut function to write at the begin of the line
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{logger}} Module}
-\label{\detokenize{commands/apidoc/src:logger-module}}\label{\detokenize{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)}
+\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
+\end{fulllineitems}
-Class to handle log mechanism.
-\index{add\_link() (src.logger.Logger method)}
+\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.add_link}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_link}}}{\emph{log\_file\_name}, \emph{command\_name}, \emph{command\_res}, \emph{full\_launched\_command}}{}
-Add a link to another log file.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1”
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
\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)}
+\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.
+\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{error() (src.logger.Logger method)}
+\index{get() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
-Print an error.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{flush() (src.logger.Logger method)}
+\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
-Flush terminal
-
-\end{fulllineitems}
-
-\index{put\_initial\_xml\_fields() (src.logger.Logger method)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{}
-Called at class initialization: Put all fields
-corresponding to the command context (user, time, …)
+\end{description}\end{quote}
\end{fulllineitems}
-\index{write() (src.logger.Logger method)}
+\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{}
-function used in the commands
-to print in the terminal and the log file.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding
-to the message 0 \textless{} level \textless{} 6.
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{date\_to\_datetime() (in module src.logger)}
+\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{}
-From a string date in format YYYYMMDD\_HHMMSS
-returns list year, mon, day, hour, minutes, seconds
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
-\item[{Returns}] \leavevmode
-the same date and time in separate variables.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
-\item[{Return type}] \leavevmode
-(str,str,str,str,str,str)
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{list\_log\_file() (in module src.logger)}
+\index{set() (src.fileEnviron.LauncherFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.list_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{list\_log\_file}}}{\emph{dirPath}, \emph{expression}}{}
-Find all files corresponding to expression in dirPath
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
\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{\detokenize{commands/apidoc/src:src.logger.show_command_log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter
-to the salomeTools command
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands
-that are not shown by default
+\end{fulllineitems}
-\end{itemize}
+\index{ScreenEnviron (class in src.fileEnviron)}
-\item[{Returns}] \leavevmode
-True if cmd is not in notShownCommands and the application
-in the log file corresponds to application
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ScreenEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
+\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
-\item[{Return type}] \leavevmode
-boolean
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a comment in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{timedelta\_total\_seconds() (in module src.logger)}
+\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{}
-Replace total\_seconds from datetime module
-in order to be compatible with old python versions
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates
-
-\item[{Returns}] \leavevmode
-The number of seconds corresponding to timedelta.
-
-\item[{Return type}] \leavevmode
-float
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
\end{description}\end{quote}
\end{fulllineitems}
-\index{update\_hat\_xml() (in module src.logger)}
+\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.update_hat_xml}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{update\_hat\_xml}}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands={[}{]}}}{}
-Create the xml file in logDir that contain all the xml file
-and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+Add some empty lines in the shell file
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
\end{description}\end{quote}
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{options}} Module}
-\label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{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)}
+\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning “echo” in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
-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{description}\end{quote}
\end{fulllineitems}
-\index{Options (class in src.options)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
-Class to manage all salomeTools options
-\index{add\_option() (src.options.Options method)}
+\index{append() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.add_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_option}}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString=''}, \emph{default=None}}{}~\begin{description}
-\item[{Method to add an option to a command. It gets all attributes}] \leavevmode
-of an option and append it in the options field
-
-\end{description}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{helpString}}) \textendash{} The short name of the option
-(ex “l” for level option).
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The long name of the option
-(ex “level” for level option).
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The type of the option (ex “int”).
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name that will be used in the code.
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to display
-when user ask for help on a command.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
-\item[{Returns}] \leavevmode
-Nothing.
-
-\item[{Return type}] \leavevmode
-NA
-
\end{description}\end{quote}
\end{fulllineitems}
-\index{parse\_args() (src.options.Options method)}
+\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}~\begin{description}
-\item[{Method that instantiates the class OptResult }] \leavevmode
-that gives access to all options in the code
-
-\end{description}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{argList}}) \textendash{} the raw list of arguments that were passed
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
-\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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
-\item[{Return type}] \leavevmode
-(class ‘common.options.OptResult’,list)
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_help() (src.options.Options method)}
+\index{get() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.print_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{print\_help}}}{}{}
-Method that display all options stored in self.options and there help
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
+Get the value of the environment variable “key”
\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-Nothing.
-
-\item[{Return type}] \leavevmode
-NA
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{printcolors}} Module}
-\label{\detokenize{commands/apidoc/src:printcolors-module}}\label{\detokenize{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)}
+\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{}
-remove color from a colored text.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
+Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned.
-
-\item[{Returns}] \leavevmode
-The cleaned text.
-
-\item[{Return type}] \leavevmode
-str
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_color\_map() (in module src.printcolors)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{}
-This method prints the color map
-
-\end{fulllineitems}
-
-\index{print\_color\_range() (in module src.printcolors)}
+\index{prepend() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_range}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_range}}}{\emph{start}, \emph{end}}{}
-print possible range values for colors
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.
+\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
\end{itemize}
\end{fulllineitems}
-\index{print\_value() (in module src.printcolors)}
+\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
+Set the environment variable ‘key’ to value ‘value’
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print.
+\end{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.
+\end{description}\end{quote}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end.
+\end{fulllineitems}
-\end{itemize}
+\index{write() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{printc() (in module src.printcolors)}
+\index{get\_file\_environ() (in module src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{}
-print a text with colors
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.get_file_environ}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.
+\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.
-
-\end{itemize}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.
-\item[{Return type}] \leavevmode
-str
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcError() (in module src.printcolors)}
+\index{special\_path\_separator() (in module src.fileEnviron)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{}
-print a text error color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
-
-\item[{Returns}] \leavevmode
-The colored text.
-
-\item[{Return type}] \leavevmode
-str
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcHeader() (in module src.printcolors)}
+
+
+\subsubsection{src.fork module}
+\label{\detokenize{commands/apidoc/src:module-src.fork}}\label{\detokenize{commands/apidoc/src:src-fork-module}}\index{src.fork (module)}\index{batch() (in module src.fork)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{}
-print a text header color
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The colored text.
+\index{batch\_salome() (in module src.fork)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{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}
-\end{description}\end{quote}
+\index{launch\_command() (in module src.fork)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.launch_command}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{launch\_command}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{}
\end{fulllineitems}
-\index{printcHighlight() (in module src.printcolors)}
+\index{show\_progress() (in module src.fork)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{}
-print a text highlight color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.show_progress}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{show\_progress}}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss=''}}{}
+shortcut function to display the progression
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display
-\item[{Return type}] \leavevmode
-str
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcInfo() (in module src.printcolors)}
+\index{write\_back() (in module src.fork)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{}
-print a text info color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.write_back}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display
-\item[{Return type}] \leavevmode
-str
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcLabel() (in module src.printcolors)}
+
+
+\subsubsection{src.logger module}
+\label{\detokenize{commands/apidoc/src:module-src.logger}}\label{\detokenize{commands/apidoc/src:src-logger-module}}\index{src.logger (module)}
+Implements the classes and method relative to the logging
+\index{Logger (class in src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{}
-print a text label color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to handle log mechanism.
+\index{add\_link() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.add_link}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link.
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.
-\item[{Return type}] \leavevmode
-str
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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{printcSuccess() (in module src.printcolors)}
+\index{end\_write() (src.logger.Logger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{}
-print a text success color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
-
-\item[{Returns}] \leavevmode
-The colored text.
-
-\item[{Return type}] \leavevmode
-str
+\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcWarning() (in module src.printcolors)}
+\index{error() (src.logger.Logger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{}
-print a text warning color
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
+Print an error.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
-\item[{Returns}] \leavevmode
-The colored text.
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-str
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{flush() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
+Flush terminal
\end{fulllineitems}
+\index{put\_initial\_xml\_fields() (src.logger.Logger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{}
+Called at class initialization: Put all fields
+corresponding to the command context (user, time, …)
+\end{fulllineitems}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{product}} Module}
-\label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{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)}
+\index{write() (src.logger.Logger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_config_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path
-(without config-\textless{}i\textgreater{})
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding
+to the message 0 \textless{} level \textless{} 6.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.
\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
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-(boolean, str)
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{check\_installation() (in module src.product)}
+\index{date\_to\_datetime() (in module src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS
\item[{Returns}] \leavevmode
-True if it is well installed
+the same date and time in separate variables.
\item[{Return type}] \leavevmode
-boolean
+(str,str,str,str,str,str)
\end{description}\end{quote}
\end{fulllineitems}
-\index{check\_source() (in module src.product)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{}
-Verify if a sources of product is preset. Checks source directory presence
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} 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)}
+\index{list\_log\_file() (in module src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_base_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_base\_install\_dir}}}{\emph{config}, \emph{prod\_info}, \emph{version}}{}
-Compute the installation directory of a product in base
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.list_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find
\end{itemize}
\item[{Returns}] \leavevmode
-The path of the product installation
+the list of files path and informations about it
\item[{Return type}] \leavevmode
-str
+list
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_install\_dir() (in module src.product)}
+\index{show\_command\_log() (in module src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_install\_dir}}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{}
-Compute the installation directory of a given product
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.show_command_log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} 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
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter
+to the salomeTools command
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands
+that are not shown by default
\end{itemize}
\item[{Returns}] \leavevmode
-The path of the product installation
+True if cmd is not in notShownCommands and the application
+in the log file corresponds to application
\item[{Return type}] \leavevmode
-str
+boolean
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_components() (in module src.product)}
+\index{timedelta\_total\_seconds() (in module src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
-Get the component list to generate with the product
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates
\item[{Returns}] \leavevmode
-The list of names of the components
+The number of seconds corresponding to timedelta.
\item[{Return type}] \leavevmode
-List
+float
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_config() (in module src.product)}
+\index{update\_hat\_xml() (in module src.logger)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_config}}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{}
-Get the specific configuration of a product from the global configuration
+\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.update_hat_xml}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{update\_hat\_xml}}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands={[}{]}}}{}
+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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install
-directory (at false only for internal use
-of the function check\_config\_exists)
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any
\end{itemize}
-\item[{Returns}] \leavevmode
-the specific configuration of the product
-
-\item[{Return type}] \leavevmode
-{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
-
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_dependencies() (in module src.product)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
-\end{itemize}
+\subsubsection{src.options module}
+\label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{commands/apidoc/src: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)}
-\item[{Returns}] \leavevmode
-the list of products in dependence
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\item[{Return type}] \leavevmode
-list
+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.
-\end{description}\end{quote}
+\begin{DUlineblock}{0em}
+\item[] Example:
+\item[] \textgreater{}\textgreater{} options, remainderArgs = command.parseArguments(args)
+\item[] \textgreater{}\textgreater{} print(options.output\_verbose\_level)
+\item[] \textgreater{}\textgreater{} ‘INFO’
+\end{DUlineblock}
\end{fulllineitems}
-\index{get\_product\_section() (in module src.product)}
+\index{Options (class in src.options)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_section}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_section}}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{}
-Get the product description from the configuration
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage all salomeTools options
+\index{add\_option() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.add_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_option}}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString=''}, \emph{default=None}}{}
+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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
+\sphinxstyleliteralstrong{\sphinxupquote{shortName}} \textendash{} (str)
+The short name of the option (as ‘-l’ for level option).
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name
+\sphinxstyleliteralstrong{\sphinxupquote{longName}} \textendash{} (str)
+The long name of the option (as ‘\textendash{}level’ for level option).
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
+\sphinxstyleliteralstrong{\sphinxupquote{optionType}} \textendash{} (str) The type of the option (ex “int”).
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is
-explicitly given
+\sphinxstyleliteralstrong{\sphinxupquote{destName}} \textendash{} (str) The name that will be used in the code.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{helpString}} \textendash{} (str)
+The text to display when user ask for help on a command.
\end{itemize}
\item[{Returns}] \leavevmode
-The product description
-
-\item[{Return type}] \leavevmode
-{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
+None
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_products\_infos() (in module src.product)}
+\index{debug\_write() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_products_infos}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.debug_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{debug\_write}}}{}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
+\index{filterLevel() (src.options.Options method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterLevel}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterLevel}}}{\emph{aLevel}}{}
+filter level logging values
-\item[{Returns}] \leavevmode
-the list of tuples
-(product name, specific configuration of the product)
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-{[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]}
+\index{filterList2() (src.options.Options method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterList2}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterList2}}}{\emph{aStr}}{}
+filter a list as ‘KERNEL,YACS,etc.’
\end{fulllineitems}
-\index{product\_compiles() (in module src.product)}
+\index{getDetailOption() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{}
-Know if a product compiles or not
-(some products do not have a compilation procedure)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.getDetailOption}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getDetailOption}}}{\emph{option}}{}
+for convenience
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
-
\item[{Returns}] \leavevmode
-True if the product compiles, else False
-
-\item[{Return type}] \leavevmode
-boolean
+(tuple) 4-elements (shortName, longName, optionType, helpString)
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_has\_env\_script() (in module src.product)}
+\index{get\_help() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_env_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_env\_script}}}{\emph{product\_info}}{}
-Know if a product has an environment script
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
+Returns all options stored in self.options
+as help message colored string
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} 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
+(str) colored string
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_has\_logo() (in module src.product)}
+\index{indent() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
-Know if a product has a logo (YACSGEN generate)
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} 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}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount}, \emph{car=' '}}{}
+indent multi lines message
\end{fulllineitems}
-\index{product\_has\_patches() (in module src.product)}
+\index{parse\_args() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
-Know if a product has one or more patches
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}
+Instantiates the class OptResult
+that gives access to all options in the code
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{argList}} \textendash{} (list) the raw list of arguments that were passed
\item[{Returns}] \leavevmode
-True if the product has one or more patches
-
-\item[{Return type}] \leavevmode
-boolean
+(OptResult, list) as (optResult, args)
+optResult is the option instance to manipulate in the code.
+args is the full raw list of passed options
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_has\_salome\_gui() (in module src.product)}
+\index{print\_help() (src.options.Options method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_salome_gui}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_salome\_gui}}}{\emph{product\_info}}{}
-Know if a product has a SALOME gui
+\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.print_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{print\_help}}}{}{}
+Method that display all options stored in self.options and there help
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
-
\item[{Returns}] \leavevmode
-True if the product has a SALOME gui, else False
-
-\item[{Return type}] \leavevmode
-Boolean
+None
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_has\_script() (in module src.product)}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.printcolors module}
+\label{\detokenize{commands/apidoc/src:module-src.printcolors}}\label{\detokenize{commands/apidoc/src:src-printcolors-module}}\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{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
-Know if a product has a compilation script
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{}
+remove color from a colored text.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned.
\item[{Returns}] \leavevmode
-True if the product it has a compilation script, else False
+The cleaned text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_autotools() (in module src.product)}
+\index{print\_color\_map() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
-Know if a product is compiled using the autotools
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{}
+This method prints the color map
+
+\end{fulllineitems}
+
+\index{print\_color\_range() (in module src.printcolors)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_range}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_range}}}{\emph{start}, \emph{end}}{}
+print possible range values for colors
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.
-\item[{Returns}] \leavevmode
-True if the product is autotools, else False
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.
-\item[{Return type}] \leavevmode
-boolean
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_cmake() (in module src.product)}
+\index{print\_value() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
-Know if a product is compiled using the cmake
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{}
+print a text with colors
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.
+
+\end{itemize}
\item[{Returns}] \leavevmode
-True if the product is cmake, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_cpp() (in module src.product)}
+\index{printcError() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
-Know if a product is cpp
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{}
+print a text error color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is a cpp, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_debug() (in module src.product)}
+\index{printcHeader() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
-Know if a product is in debug mode
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{}
+print a text header color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is in debug mode, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_dev() (in module src.product)}
+\index{printcHighlight() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
-Know if a product is in dev mode
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{}
+print a text highlight color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is in dev mode, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_fixed() (in module src.product)}
+\index{printcInfo() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
-Know if a product is fixed
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{}
+print a text info color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is fixed, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_generated() (in module src.product)}
+\index{printcLabel() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
-Know if a product is generated (YACSGEN)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{}
+print a text label color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is generated
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_mpi() (in module src.product)}
+\index{printcSuccess() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
-Know if a product has openmpi in its dependencies
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{}
+print a text success color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product has openmpi inits dependencies
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_native() (in module src.product)}
+\index{printcWarning() (in module src.printcolors)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
-Know if a product is native
+\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{}
+print a text warning color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
\item[{Returns}] \leavevmode
-True if the product is native, else False
+The colored text.
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_salome() (in module src.product)}
+
+
+\subsubsection{src.product module}
+\label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{commands/apidoc/src: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{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
-Know if a product is a SALOME module
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_config_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path
+(without config-\textless{}i\textgreater{})
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
the product
+\end{itemize}
+
\item[{Returns}] \leavevmode
-True if the product is a SALOME module, else False
+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
+(boolean, str)
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_sample() (in module src.product)}
+\index{check\_installation() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_sample}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_sample}}}{\emph{product\_info}}{}
-Know if a product has the sample type
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
the product
\item[{Returns}] \leavevmode
-True if the product has the sample type, else False
+True if it is well installed
\item[{Return type}] \leavevmode
boolean
\end{fulllineitems}
-\index{product\_is\_smesh\_plugin() (in module src.product)}
+\index{check\_source() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_smesh_plugin}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_smesh\_plugin}}}{\emph{product\_info}}{}
-Know if a product is a SMESH plugin
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{}
+Verify if a sources of product is preset. Checks source directory presence
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
the product
\item[{Returns}] \leavevmode
-True if the product is a SMESH plugin, else False
+True if it is well installed
\item[{Return type}] \leavevmode
boolean
\end{fulllineitems}
-\index{product\_is\_vcs() (in module src.product)}
+\index{get\_base\_install\_dir() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{}
-Know if a product is download using git, svn or cvs (not archive)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_base_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
the product
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product
+
+\end{itemize}
+
\item[{Returns}] \leavevmode
-True if the product is vcs, else False
+The path of the product installation
\item[{Return type}] \leavevmode
-boolean
+str
\end{description}\end{quote}
\end{fulllineitems}
+\index{get\_install\_dir() (in module src.product)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{pyconf}} Module}
-\label{\detokenize{commands/apidoc/src:pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
-This is a configuration module for Python.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} 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
-This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
-earlier versions since it uses new-style classes.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
-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{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
-download link).
-
-A simple example - with the example configuration file:
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
+the product
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
-messages:
-[
- \PYGZob{}
- stream : {}`sys.stderr{}`
- message: \PYGZsq{}Welcome\PYGZsq{}
- name: \PYGZsq{}Harry\PYGZsq{}
- \PYGZcb{}
- \PYGZob{}
- stream : {}`sys.stdout{}`
- message: \PYGZsq{}Welkom\PYGZsq{}
- name: \PYGZsq{}Ruud\PYGZsq{}
- \PYGZcb{}
- \PYGZob{}
- stream : \PYGZdl{}messages[0].stream
- message: \PYGZsq{}Bienvenue\PYGZsq{}
- name: Yves
- \PYGZcb{}
-]
-\end{sphinxVerbatim}
+\end{itemize}
-a program to read the configuration would be:
+\item[{Returns}] \leavevmode
+The path of the product installation
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
-\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
+\item[{Return type}] \leavevmode
+str
-\PYG{n}{f} \PYG{o}{=} \PYG{n}{file}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{simple.cfg}\PYG{l+s+s1}{\PYGZsq{}}\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+s1}{\PYGZsq{}}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{\PYGZsq{}} \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{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \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{n+nb}{print} \PYG{n}{e}
-\end{sphinxVerbatim}
+\end{description}\end{quote}
-which, when run, would yield the console output:
+\end{fulllineitems}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[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{sphinxVerbatim}
+\index{get\_product\_components() (in module src.product)}
-See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
-information.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
+Get the component list to generate with the product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-\#modified for salomeTools
-@version: 0.3.7.1
+\item[{Returns}] \leavevmode
+The list of names of the components
-@author: Vinay Sajip
+\item[{Return type}] \leavevmode
+List
-@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
+\end{description}\end{quote}
-@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.
+\end{fulllineitems}
-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)}
+\index{get\_product\_config() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Config}}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Mapping}})
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
-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)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install
+directory (at false only for internal use
+of the function check\_config\_exists)
-This internal class is used for implementing default namespaces.
+\end{itemize}
-An instance acts as a namespace.
+\item[{Returns}] \leavevmode
+the specific configuration of the product
+
+\item[{Return type}] \leavevmode
+{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{addNamespace() (src.pyconf.Config method)}
+\index{get\_product\_dependencies() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
+the product
-\index{getByPath() (src.pyconf.Config method)}
+\end{itemize}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\item[{Returns}] \leavevmode
+the list of products in dependence
+
+\item[{Return type}] \leavevmode
+list
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{load() (src.pyconf.Config method)}
+\index{get\_product\_section() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_section}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name
-\index{removeNamespace() (src.pyconf.Config method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is
+explicitly given
-\end{fulllineitems}
+\end{itemize}
+\item[{Returns}] \leavevmode
+The product description
+
+\item[{Return type}] \leavevmode
+{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ConfigError}
+\index{get\_products\_infos() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
-Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_products_infos}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names
-This is the base class of exceptions raised by this module.
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
-\end{fulllineitems}
+\end{itemize}
-\index{ConfigFormatError}
+\item[{Returns}] \leavevmode
+the list of tuples
+(product name, specific configuration of the product)
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
+\item[{Return type}] \leavevmode
+{[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]}
-This is the base class of exceptions raised due to syntax errors in
-configurations.
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ConfigInputStream (class in src.pyconf)}
+\index{product\_compiles() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
-
-An input stream which can read either ANSI files with default encoding
-or Unicode files with BOMs.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
-built-in support.
-\index{close() (src.pyconf.ConfigInputStream method)}
+\item[{Returns}] \leavevmode
+True if the product compiles, else False
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+boolean
-\index{read() (src.pyconf.ConfigInputStream method)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
\end{fulllineitems}
-\index{readline() (src.pyconf.ConfigInputStream method)}
+\index{product\_has\_env\_script() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_env_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_env\_script}}}{\emph{product\_info}}{}
+Know if a product has an environment script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
+\item[{Returns}] \leavevmode
+True if the product it has an environment script, else False
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+boolean
-\index{ConfigList (class in src.pyconf)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
-Bases: \sphinxcode{\sphinxupquote{list}}
+\end{fulllineitems}
-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)}
+\index{product\_has\_logo() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
-Obtain a value from the first configuration in the list which defines
-it.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
+Know if a product has a logo (YACSGEN generate)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@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.
+\item[{Returns}] \leavevmode
+The path of the logo if the product has a logo, else False
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+Str
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ConfigMerger (class in src.pyconf)}
+\index{product\_has\_patches() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigMerger}}}{\emph{resolver=\textless{}function defaultMergeResolve at 0x36fa5f0\textgreater{}}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
+Know if a product has one or more patches
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-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)}
+\item[{Returns}] \leavevmode
+True if the product has one or more patches
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
-Handle a mismatch between two objects.
+\item[{Return type}] \leavevmode
+boolean
-@param obj1: The object to merge into.
-@type obj1: any
-@param obj2: The object to merge.
-@type obj2: any
+\end{description}\end{quote}
\end{fulllineitems}
-\index{merge() (src.pyconf.ConfigMerger method)}
+\index{product\_has\_salome\_gui() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_salome_gui}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_salome\_gui}}}{\emph{product\_info}}{}
+Know if a product has a SALOME gui
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has a SALOME gui, else False
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\item[{Return type}] \leavevmode
+Boolean
-@param merged: The configuration to merge into.
-@type merged: L\{Config\}.
-@param mergee: The configuration to merge.
-@type mergee: L\{Config\}.
+\end{description}\end{quote}
\end{fulllineitems}
-\index{mergeMapping() (src.pyconf.ConfigMerger method)}
+\index{product\_has\_script() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
+Know if a product has a compilation script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@param map1: The mapping to merge into.
-@type map1: L\{Mapping\}.
-@param map2: The mapping to merge.
-@type map2: L\{Mapping\}.
+\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{mergeSequence() (src.pyconf.ConfigMerger method)}
+\index{product\_is\_autotools() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
+Know if a product is compiled using the autotools
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@param seq1: The sequence to merge into.
-@type seq1: L\{Sequence\}.
-@param seq2: The sequence to merge.
-@type seq2: L\{Sequence\}.
+\item[{Returns}] \leavevmode
+True if the product is autotools, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{overwriteKeys() (src.pyconf.ConfigMerger method)}
+\index{product\_is\_cmake() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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\}.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
+Know if a product is compiled using the cmake
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+True if the product is cmake, else False
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ConfigOutputStream (class in src.pyconf)}
+\index{product\_is\_cpp() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigOutputStream}}}{\emph{stream}, \emph{encoding=None}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
+Know if a product is cpp
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-An output stream which can write either ANSI files with default encoding
-or Unicode files with BOMs.
+\item[{Returns}] \leavevmode
+True if the product is a cpp, else False
-Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
-built-in support.
-\index{close() (src.pyconf.ConfigOutputStream method)}
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}
-\index{flush() (src.pyconf.ConfigOutputStream method)}
+\index{product\_is\_debug() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
+Know if a product is in debug mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-\index{write() (src.pyconf.ConfigOutputStream method)}
+\item[{Returns}] \leavevmode
+True if the product is in debug mode, else False
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+boolean
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ConfigReader (class in src.pyconf)}
+\index{product\_is\_dev() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
+Know if a product is in dev mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-This internal class implements a parser for configurations.
-\index{getChar() (src.pyconf.ConfigReader method)}
+\item[{Returns}] \leavevmode
+True if the product is in dev mode, else False
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
-Get the next char from the stream. Update line and column numbers
-appropriately.
+\item[{Return type}] \leavevmode
+boolean
-@return: The next character from the stream.
-@rtype: str
+\end{description}\end{quote}
\end{fulllineitems}
-\index{getToken() (src.pyconf.ConfigReader method)}
+\index{product\_is\_fixed() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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).
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
+Know if a product is fixed
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-Multiline string tokenizing is thanks to David Janes (BlogMatrix)
+\item[{Returns}] \leavevmode
+True if the product is fixed, else False
-@return: The next token.
-@rtype: A token tuple.
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{load() (src.pyconf.ConfigReader method)}
+\index{product\_is\_generated() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
-Load the configuration from the specified stream.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
+Know if a product is generated (YACSGEN)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@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.
+\item[{Returns}] \leavevmode
+True if the product is generated
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{location() (src.pyconf.ConfigReader method)}
+\index{product\_is\_mpi() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
-Return the current location (filename, line, column) in the stream
-as a string.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
+Know if a product has openmpi in its dependencies
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-Used when printing error messages,
+\item[{Returns}] \leavevmode
+True if the product has openmpi inits dependencies
-@return: A string representing a location in the stream being read.
-@rtype: str
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{match() (src.pyconf.ConfigReader method)}
+\index{product\_is\_native() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
-Ensure that the current token type matches the specified value, and
-advance to the next token.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
+Know if a product is native
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@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.
+\item[{Returns}] \leavevmode
+True if the product is native, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{parseFactor() (src.pyconf.ConfigReader method)}
+\index{product\_is\_salome() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
-Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
+Know if a product is a SALOME module
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a SALOME module, else False
+
+\item[{Return type}] \leavevmode
+boolean
-@return: the parsed factor
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.
+\end{description}\end{quote}
\end{fulllineitems}
-\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
+\index{product\_is\_smesh\_plugin() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
-Parse a key-value pair, and add it to the provided L\{Mapping\}.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_smesh_plugin}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_smesh\_plugin}}}{\emph{product\_info}}{}
+Know if a product is a SMESH plugin
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@param parent: The mapping to add entries to.
-@type parent: A L\{Mapping\} instance.
-@raise ConfigFormatError: if a syntax error is found.
+\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{parseMapping() (src.pyconf.ConfigReader method)}
+\index{product\_is\_vcs() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
-Parse a mapping.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@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.
+\item[{Returns}] \leavevmode
+True if the product is vcs, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{parseMappingBody() (src.pyconf.ConfigReader method)}
+\index{product\_is\_verbose() (in module src.product)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
-Parse the internals of a mapping, and add entries to the provided
-L\{Mapping\}.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_verbose}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_verbose}}}{\emph{product\_info}}{}
+Know if a product is in verbose mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+the product
-@param parent: The mapping to add entries to.
-@type parent: A L\{Mapping\} instance.
+\item[{Returns}] \leavevmode
+True if the product is in verbose mode, else False
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+boolean
-\index{parseReference() (src.pyconf.ConfigReader method)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
-Parse a reference.
+\end{fulllineitems}
-@return: the parsed reference
-@rtype: L\{Reference\}
-@raise ConfigFormatError: if a syntax error is found.
-\end{fulllineitems}
-\index{parseScalar() (src.pyconf.ConfigReader method)}
+\subsubsection{src.pyconf module}
+\label{\detokenize{commands/apidoc/src:src-pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
+This is a configuration module for Python.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
-Parse a scalar - a terminal value such as a string or number, or
-an L\{Expression\} or L\{Reference\}.
+This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
+earlier versions since it uses new-style classes.
-@return: the parsed scalar
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.
+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{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
+download link).
-\end{fulllineitems}
+A simple example - with the example configuration file:
-\index{parseSequence() (src.pyconf.ConfigReader method)}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+messages:
+[
+ \PYGZob{}
+ stream : {}`sys.stderr{}`
+ message: \PYGZsq{}Welcome\PYGZsq{}
+ name: \PYGZsq{}Harry\PYGZsq{}
+ \PYGZcb{}
+ \PYGZob{}
+ stream : {}`sys.stdout{}`
+ message: \PYGZsq{}Welkom\PYGZsq{}
+ name: \PYGZsq{}Ruud\PYGZsq{}
+ \PYGZcb{}
+ \PYGZob{}
+ stream : \PYGZdl{}messages[0].stream
+ message: \PYGZsq{}Bienvenue\PYGZsq{}
+ name: Yves
+ \PYGZcb{}
+]
+\end{sphinxVerbatim}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
-Parse a sequence.
+a program to read the configuration would be:
-@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.
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
-\end{fulllineitems}
+\PYG{n}{f} \PYG{o}{=} \PYG{n}{file}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{simple.cfg}\PYG{l+s+s1}{\PYGZsq{}}\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+s1}{\PYGZsq{}}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{\PYGZsq{}} \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{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \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{n+nb}{print} \PYG{n}{e}
+\end{sphinxVerbatim}
-\index{parseSuffix() (src.pyconf.ConfigReader method)}
+which, when run, would yield the console output:
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
-Parse a reference suffix.
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[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{sphinxVerbatim}
-@param ref: The reference of which this suffix is a part.
-@type ref: L\{Reference\}.
-@raise ConfigFormatError: if a syntax error is found.
+See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
+information.
-\end{fulllineitems}
+\#modified for salomeTools
+@version: 0.3.7.1
-\index{parseTerm() (src.pyconf.ConfigReader method)}
+@author: Vinay Sajip
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
-Parse a term in an additive expression (a + b, a - b)
+@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
-@return: the parsed term
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.
+@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.
-\end{fulllineitems}
+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)}
-\index{parseValue() (src.pyconf.ConfigReader method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Config}}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src: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{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
-Parse a value.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
-@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.
+This internal class is used for implementing default namespaces.
+
+An instance acts as a namespace.
\end{fulllineitems}
-\index{setStream() (src.pyconf.ConfigReader method)}
+\index{addNamespace() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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).
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{ConfigResolutionError}
+\index{load() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
-
-This is the base class of exceptions raised due to semantic errors in
-configurations.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{Container (class in src.pyconf)}
+\index{removeNamespace() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-This internal class is the base class for mappings and sequences.
+\end{fulllineitems}
-@ivar path: A string which describes how to get
-to this instance from the root of the hierarchy.
-Example:
+\end{fulllineitems}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
-\PYG{n}{a}\PYG{o}{.}\PYG{n}{list}\PYG{o}{.}\PYG{n}{of}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{o}{.}\PYG{o+ow}{or}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{more}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{o}{.}\PYG{n}{elements}
-\end{sphinxVerbatim}
-\index{evaluate() (src.pyconf.Container method)}
+\index{ConfigError}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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\}.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
+Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
-@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.
+This is the base class of exceptions raised by this module.
\end{fulllineitems}
-\index{setPath() (src.pyconf.Container method)}
+\index{ConfigFormatError}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
+
+This is the base class of exceptions raised due to syntax errors in
+configurations.
\end{fulllineitems}
-\index{writeToStream() (src.pyconf.Container method)}
+\index{ConfigInputStream (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
-Write this instance to a stream at the specified indentation level.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-Should be redefined in subclasses.
+An input stream which can read either ANSI files with default encoding
+or Unicode files with BOMs.
-@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
+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{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
+
+\index{read() (src.pyconf.ConfigInputStream method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
\end{fulllineitems}
-\index{writeValue() (src.pyconf.Container method)}
+\index{readline() (src.pyconf.ConfigInputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
\end{fulllineitems}
\end{fulllineitems}
-\index{Expression (class in src.pyconf)}
+\index{ConfigList (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Expression}}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
+Bases: \sphinxcode{\sphinxupquote{list}}
-This internal class implements a value which is obtained by evaluating an expression.
-\index{evaluate() (src.pyconf.Expression method)}
+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{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
-Evaluate this instance in the context of a container.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
+Obtain a value from the first configuration in the list which defines
+it.
-@param container: The container to evaluate in from.
-@type container: L\{Container\}
-@return: The evaluated value.
+@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 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.
+@raise ConfigError: If no configuration in the list has an entry with
+the specified path.
\end{fulllineitems}
\end{fulllineitems}
-\index{Mapping (class in src.pyconf)}
+\index{ConfigMerger (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigMerger}}}{\emph{resolver=\textless{}function defaultMergeResolve\textgreater{}}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-This internal class implements key-value mappings in configurations.
-\index{addMapping() (src.pyconf.Mapping method)}
+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{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
-Add a key-value mapping with a comment.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
+Handle a mismatch between two objects.
-@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.
+@param obj1: The object to merge into.
+@type obj1: any
+@param obj2: The object to merge.
+@type obj2: any
\end{fulllineitems}
-\index{get() (src.pyconf.Mapping method)}
+\index{merge() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
-Allows a dictionary-style get operation.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{iteritems() (src.pyconf.Mapping method)}
+\index{mergeMapping() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
-\index{iterkeys() (src.pyconf.Mapping method)}
+@param map1: The mapping to merge into.
+@type map1: L\{Mapping\}.
+@param map2: The mapping to merge.
+@type map2: L\{Mapping\}.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
\end{fulllineitems}
-\index{keys() (src.pyconf.Mapping method)}
+\index{mergeSequence() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
-Return the keys in a similar way to a dictionary.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{writeToStream() (src.pyconf.Mapping method)}
+\index{overwriteKeys() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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\}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{Reference (class in src.pyconf)}
+\index{ConfigOutputStream (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Reference}}}{\emph{config}, \emph{type}, \emph{ident}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigOutputStream}}}{\emph{stream}, \emph{encoding=None}}{}
Bases: \sphinxcode{\sphinxupquote{object}}
-This internal class implements a value which is a reference to another value.
-\index{addElement() (src.pyconf.Reference method)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
-Add an element to the reference.
+An output stream which can write either ANSI files with default encoding
+or Unicode files with BOMs.
-@param type: The type of reference.
-@type type: BACKTICK or DOLLAR
-@param ident: The identifier which continues the reference.
-@type ident: str
+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{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}
-\index{findConfig() (src.pyconf.Reference method)}
+\index{flush() (src.pyconf.ConfigOutputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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\}
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
\end{fulllineitems}
-\index{resolve() (src.pyconf.Reference method)}
+\index{write() (src.pyconf.ConfigOutputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
\end{fulllineitems}
\end{fulllineitems}
-\index{Sequence (class in src.pyconf)}
+\index{ConfigReader (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
-Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-This internal class implements a value which is a sequence of other values.
-\index{Sequence.SeqIter (class in src.pyconf)}
+This internal class implements a parser for configurations.
+\index{getChar() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
+Get the next char from the stream. Update line and column numbers
+appropriately.
-This internal class implements an iterator for a L\{Sequence\} instance.
-\index{next() (src.pyconf.Sequence.SeqIter method)}
+@return: The next character from the stream.
+@rtype: str
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}
+\index{getToken() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{append() (src.pyconf.Sequence method)}
+\index{load() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
-Add an item to the sequence.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
+Load the configuration from the specified stream.
-@param item: The item to add.
-@type item: any
-@param comment: A comment for the item.
-@type comment: str
+@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{writeToStream() (src.pyconf.Sequence method)}
+\index{location() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
-Write this instance to a stream at the specified indentation level.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
+Return the current location (filename, line, column) in the stream
+as a string.
-Should be redefined in subclasses.
+Used when printing error messages,
-@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\}
+@return: A string representing a location in the stream being read.
+@rtype: str
\end{fulllineitems}
+\index{match() (src.pyconf.ConfigReader method)}
-\end{fulllineitems}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
+Ensure that the current token type matches the specified value, and
+advance to the next token.
-\index{deepCopyMapping() (in module src.pyconf)}
+@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.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
\end{fulllineitems}
-\index{defaultMergeResolve() (in module src.pyconf)}
+\index{parseFactor() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
+Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
-@rtype: str
+@return: the parsed factor
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
\end{fulllineitems}
-\index{defaultStreamOpener() (in module src.pyconf)}
+\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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().
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
+Parse a key-value pair, and add it to the provided L\{Mapping\}.
-@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)
+@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{isWord() (in module src.pyconf)}
+\index{parseMapping() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
+Parse a mapping.
-Examples:
+@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.
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
-\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a word}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{False}
-\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{award}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{True}
-\PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
-\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a\PYGZus{}b\PYGZus{}c\PYGZus{}}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{True}
-\end{sphinxVerbatim}
+\end{fulllineitems}
-@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
-for the way it’s used here.
+\index{parseMappingBody() (src.pyconf.ConfigReader method)}
-@param s: The name to be tested
-@type s: any
-@return: True if a word, else False
-@rtype: bool
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{makePath() (in module src.pyconf)}
+\index{parseReference() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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{]}’
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
+Parse a reference.
-@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
+@return: the parsed reference
+@rtype: L\{Reference\}
+@raise ConfigFormatError: if a syntax error is found.
\end{fulllineitems}
-\index{overwriteMergeResolve() (in module src.pyconf)}
+\index{parseScalar() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
+Parse a scalar - a terminal value such as a string or number, or
+an L\{Expression\} or L\{Reference\}.
-@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
+@return: the parsed scalar
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
\end{fulllineitems}
-
-
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{system}} Module}
-\label{\detokenize{commands/apidoc/src:system-module}}\label{\detokenize{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)}
+\index{parseSequence() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.system.archive_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{archive\_extract}}}{\emph{from\_what}, \emph{where}, \emph{logger}}{}
-Extracts sources from an archive.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
+Parse a sequence.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+@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{itemize}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-True if the extraction is successful
+\index{parseSuffix() (src.pyconf.ConfigReader method)}
-\item[{Return type}] \leavevmode
-boolean
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
+Parse a reference suffix.
-\end{description}\end{quote}
+@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{cvs\_extract() (in module src.system)}
+\index{parseTerm() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.system.cvs_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
+Parse a term in an additive expression (a + b, a - b)
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.
+@return: the parsed term
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{}
-.
+\index{parseValue() (src.pyconf.ConfigReader method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
+Parse a value.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
+@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.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\index{setStream() (src.pyconf.ConfigReader method)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
+Set the stream to the specified value, and prepare to read from it.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.
+@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
-extracting.
+\end{fulllineitems}
-\end{itemize}
-\item[{Returns}] \leavevmode
-True if the extraction is successful
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-boolean
+\index{ConfigResolutionError}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
+
+This is the base class of exceptions raised due to semantic errors in
+configurations.
\end{fulllineitems}
-\index{git\_extract() (in module src.system)}
+\index{Container (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.system.git_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+This internal class is the base class for mappings and sequences.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+@ivar path: A string which describes how to get
+to this instance from the root of the hierarchy.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
-extracting.
+Example:
-\end{itemize}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{a}\PYG{o}{.}\PYG{n}{list}\PYG{o}{.}\PYG{n}{of}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{o}{.}\PYG{o+ow}{or}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{more}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{o}{.}\PYG{n}{elements}
+\end{sphinxVerbatim}
+\index{evaluate() (src.pyconf.Container method)}
-\item[{Returns}] \leavevmode
-True if the extraction is successful
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
+Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
-\item[{Return type}] \leavevmode
-boolean
+L\{Reference\} instances are evaluated using L\{Reference.resolve\},
+and L\{Expression\} instances are evaluated using
+L\{Expression.evaluate\}.
-\end{description}\end{quote}
+@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{show\_in\_editor() (in module src.system)}
+\index{setPath() (src.pyconf.Container method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.system.show_in_editor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{show\_in\_editor}}}{\emph{editor}, \emph{filePath}, \emph{logger}}{}
-open filePath using editor.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.
+\end{fulllineitems}
-\end{itemize}
+\index{writeToStream() (src.pyconf.Container method)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{svn\_extract() (in module src.system)}
+\index{writeValue() (src.pyconf.Container method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.system.svn_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\index{Expression (class in src.pyconf)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Expression}}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
-extracting.
+This internal class implements a value which is obtained by evaluating an expression.
+\index{evaluate() (src.pyconf.Expression method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
+Evaluate this instance in the context of a container.
-\item[{Returns}] \leavevmode
-True if the extraction is successful
+@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.
-\item[{Return type}] \leavevmode
-boolean
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
+\index{Mapping (class in src.pyconf)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{template}} Module}
-\label{\detokenize{commands/apidoc/src:template-module}}\label{\detokenize{commands/apidoc/src:module-src.template}}\index{src.template (module)}\index{MyTemplate (class in src.template)}
+This internal class implements key-value mappings in configurations.
+\index{addMapping() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
-Bases: \sphinxcode{\sphinxupquote{string.Template}}
-\index{delimiter (src.template.MyTemplate attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
\end{fulllineitems}
-\index{pattern (src.template.MyTemplate attribute)}
+\index{get() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x37f8420\textgreater{}}}}
-\end{fulllineitems}
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
+Allows a dictionary-style get operation.
\end{fulllineitems}
-\index{substitute() (in module src.template)}
+\index{iteritems() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
\end{fulllineitems}
+\index{iterkeys() (src.pyconf.Mapping method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
+\end{fulllineitems}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{test\_module}} Module}
-\label{\detokenize{commands/apidoc/src:module-src.test_module}}\label{\detokenize{commands/apidoc/src:test-module-module}}\index{src.test\_module (module)}\index{Test (class in src.test\_module)}
+\index{keys() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{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)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
+Return the keys in a similar way to a dictionary.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
\end{fulllineitems}
-\index{generate\_script() (src.test\_module.Test method)}
+\index{writeToStream() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
-\index{get\_test\_timeout() (src.test\_module.Test method)}
+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\}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_test_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_test\_timeout}}}{\emph{test\_name}, \emph{default\_value}}{}
\end{fulllineitems}
-\index{get\_tmp\_dir() (src.test\_module.Test method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
\end{fulllineitems}
-\index{prepare\_testbase() (src.test\_module.Test method)}
+\index{Reference (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Reference}}}{\emph{config}, \emph{type}, \emph{ident}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
+This internal class implements a value which is a reference to another value.
+\index{addElement() (src.pyconf.Reference method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_dir}}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
+Add an element to the reference.
-\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
+@param type: The type of reference.
+@type type: BACKTICK or DOLLAR
+@param ident: The identifier which continues the reference.
+@type ident: str
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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)}
+\index{findConfig() (src.pyconf.Reference method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_svn}}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{read\_results() (src.test\_module.Test method)}
+\index{resolve() (src.pyconf.Reference method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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}
-\index{run\_all\_tests() (src.test\_module.Test method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
\end{fulllineitems}
-\index{run\_grid\_tests() (src.test\_module.Test method)}
+\index{Sequence (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
+Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
-\index{run\_script() (src.test\_module.Test method)}
+This internal class implements a value which is a sequence of other values.
+\index{Sequence.SeqIter (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\index{run\_session\_tests() (src.test\_module.Test method)}
+This internal class implements an iterator for a L\{Sequence\} instance.
+\index{next() (src.pyconf.Sequence.SeqIter method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}
-\index{run\_testbase\_tests() (src.test\_module.Test method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
\end{fulllineitems}
-\index{run\_tests() (src.test\_module.Test method)}
+\index{append() (src.pyconf.Sequence method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
+Add an item to the sequence.
-\index{search\_known\_errors() (src.test\_module.Test method)}
+@param item: The item to add.
+@type item: any
+@param comment: A comment for the item.
+@type comment: str
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.search_known_errors}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{search\_known\_errors}}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
\end{fulllineitems}
-\index{write\_test\_margin() (src.test\_module.Test method)}
+\index{writeToStream() (src.pyconf.Sequence method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{getTmpDirDEFAULT() (in module src.test\_module)}
+\index{deepCopyMapping() (in module src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
\end{fulllineitems}
+\index{defaultMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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}
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{xmlManager}} Module}
-\label{\detokenize{commands/apidoc/src:xmlmanager-module}}\label{\detokenize{commands/apidoc/src:module-src.xmlManager}}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)}
+@rtype: str
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\end{fulllineitems}
-Class to manage reading of an xml log file
-\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
+\index{defaultStreamOpener() (in module src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
-Get the attibutes of the self.xmlroot
-\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-The attributes of the root node
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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.
-\item[{Return type}] \leavevmode
-dict
+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().
-\end{description}\end{quote}
+@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{get\_attrib() (src.xmlManager.ReadXmlFile method)}
+\index{isWord() (in module src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
-Get the attibutes of the node node\_name in self.xmlroot
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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.
-\item[{Returns}] \leavevmode
-the attibutes of the node node\_name in self.xmlroot
+Examples:
-\item[{Return type}] \leavevmode
-dict
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a word}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{False}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{award}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{True}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a\PYGZus{}b\PYGZus{}c\PYGZus{}}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{True}
+\end{sphinxVerbatim}
-\end{description}\end{quote}
+@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{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
+\index{makePath() (in module src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description}
-\item[{Get the text of the first node that has name }] \leavevmode
-that corresponds to the parameter node
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{}
+Make a path from a prefix and suffix.
-\end{description}
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text
+Examples:
+makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
+makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
+makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’
-\item[{Returns}] \leavevmode
-the text of the first node that has name
-that corresponds to the parameter node
+@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
-\item[{Return type}] \leavevmode
-str
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{overwriteMergeResolve() (in module src.pyconf)}
-\end{fulllineitems}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{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}
-\index{XmlLogFile (class in src.xmlManager)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{XmlLogFile}}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
-Class to manage writing in salomeTools xml log file
-\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
+\subsubsection{src.system module}
+\label{\detokenize{commands/apidoc/src:src-system-module}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
-Add a node with some attibutes and text to the root node.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.system.archive_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{archive\_extract}}}{\emph{from\_what}, \emph{where}, \emph{logger}}{}
+Extracts sources from an archive.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
-attribute of the new node
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} 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{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
+\index{cvs\_extract() (in module src.system)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{}
-Append a new attributes to the node that has node\_name as name
+\phantomsection\label{\detokenize{commands/apidoc/src:src.system.cvs_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
-
-\end{itemize}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.
-\end{description}\end{quote}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{}
+.
-\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.
-\end{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
-\end{description}\end{quote}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.
-\index{write\_tree() (src.xmlManager.XmlLogFile method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
+extracting.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file
+\end{itemize}
-\end{description}\end{quote}
+\item[{Returns}] \leavevmode
+True if the extraction is successful
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+boolean
+\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_simple\_node() (in module src.xmlManager)}
+\index{git\_extract() (in module src.system)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.add_simple_node}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.system.git_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
-attribute of the new node
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} 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{append\_node\_attrib() (in module src.xmlManager)}
+\index{show\_in\_editor() (in module src.system)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.append_node_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{root\_node}, \emph{attrib}}{}
-Append a new attributes to the node that has node\_name as name
+\phantomsection\label{\detokenize{commands/apidoc/src:src.system.show_in_editor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{show\_in\_editor}}}{\emph{editor}, \emph{filePath}, \emph{logger}}{}
+open filePath using editor.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element
-where to append the new attibutes
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.
\end{itemize}
\end{fulllineitems}
-\index{find\_node\_by\_attrib() (in module src.xmlManager)}
+\index{svn\_extract() (in module src.system)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.find_node_by_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{find\_node\_by\_attrib}}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}~\begin{description}
-\item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode
-its attributes \{key : value\}. Return the node
-
-\end{description}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.system.svn_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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)}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.write_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{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 {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file
+\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file
+\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
+extracting.
\end{itemize}
-\end{description}\end{quote}
-
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+True if the extraction is successful
+\item[{Return type}] \leavevmode
+boolean
+\end{description}\end{quote}
-\subsubsection{Subpackages}
-\label{\detokenize{commands/apidoc/src:subpackages}}
+\end{fulllineitems}
-\paragraph{colorama Package}
-\label{\detokenize{commands/apidoc/src.colorama:colorama-package}}\label{\detokenize{commands/apidoc/src.colorama::doc}}
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{colorama}} Package}
-\label{\detokenize{commands/apidoc/src.colorama:id1}}\phantomsection\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama}}\index{src.colorama (module)}
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{ansi}} Module}
-\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansi}}\label{\detokenize{commands/apidoc/src.colorama:ansi-module}}\index{src.colorama.ansi (module)}
-This module generates ANSI character codes to printing colors to terminals.
-See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
-\index{AnsiBack (class in src.colorama.ansi)}
+\subsubsection{src.template module}
+\label{\detokenize{commands/apidoc/src:module-src.template}}\label{\detokenize{commands/apidoc/src:src-template-module}}\index{src.template (module)}\index{MyTemplate (class in src.template)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}}
-Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
-\index{BLACK (src.colorama.ansi.AnsiBack attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
+Bases: \sphinxcode{\sphinxupquote{string.Template}}
+\index{delimiter (src.template.MyTemplate attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
\end{fulllineitems}
-\index{BLUE (src.colorama.ansi.AnsiBack attribute)}
+\index{pattern (src.template.MyTemplate attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}
-\index{CYAN (src.colorama.ansi.AnsiBack attribute)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
\end{fulllineitems}
-\index{GREEN (src.colorama.ansi.AnsiBack attribute)}
+\index{substitute() (in module src.template)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
\end{fulllineitems}
-\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
-\end{fulllineitems}
-\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
+\subsubsection{src.test\_module module}
+\label{\detokenize{commands/apidoc/src:module-src.test_module}}\label{\detokenize{commands/apidoc/src:src-test-module-module}}\index{src.test\_module (module)}\index{Test (class in src.test\_module)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
-\end{fulllineitems}
-
-\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{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{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
\end{fulllineitems}
-\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{generate\_script() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
\end{fulllineitems}
-\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{get\_test\_timeout() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_test_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_test\_timeout}}}{\emph{test\_name}, \emph{default\_value}}{}
\end{fulllineitems}
-\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{get\_tmp\_dir() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
\end{fulllineitems}
-\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{prepare\_testbase() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
\end{fulllineitems}
-\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_dir}}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
\end{fulllineitems}
-\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
+\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_git}}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{}
\end{fulllineitems}
-\index{RED (src.colorama.ansi.AnsiBack attribute)}
+\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_svn}}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
\end{fulllineitems}
-\index{RESET (src.colorama.ansi.AnsiBack attribute)}
+\index{read\_results() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
\end{fulllineitems}
-\index{WHITE (src.colorama.ansi.AnsiBack attribute)}
+\index{run\_all\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
\end{fulllineitems}
-\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
+\index{run\_grid\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
\end{fulllineitems}
+\index{run\_script() (src.test\_module.Test method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
\end{fulllineitems}
-\index{AnsiCodes (class in src.colorama.ansi)}
+\index{run\_session\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
-
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
\end{fulllineitems}
-\index{AnsiCursor (class in src.colorama.ansi)}
-
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
-\index{BACK() (src.colorama.ansi.AnsiCursor method)}
+\index{run\_testbase\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
\end{fulllineitems}
-\index{DOWN() (src.colorama.ansi.AnsiCursor method)}
+\index{run\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
\end{fulllineitems}
-\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
+\index{search\_known\_errors() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.search_known_errors}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{search\_known\_errors}}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
\end{fulllineitems}
-\index{POS() (src.colorama.ansi.AnsiCursor method)}
+\index{write\_test\_margin() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
\end{fulllineitems}
-\index{UP() (src.colorama.ansi.AnsiCursor method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
\end{fulllineitems}
+\index{getTmpDirDEFAULT() (in module src.test\_module)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
\end{fulllineitems}
-\index{AnsiFore (class in src.colorama.ansi)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}}
-Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
-\index{BLACK (src.colorama.ansi.AnsiFore attribute)}
+
+\subsubsection{src.xmlManager module}
+\label{\detokenize{commands/apidoc/src:src-xmlmanager-module}}\label{\detokenize{commands/apidoc/src:module-src.xmlManager}}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\index{BLUE (src.colorama.ansi.AnsiFore attribute)}
+Class to manage reading of an xml log file
+\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
+Get the attibutes of the self.xmlroot
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+The attributes of the root node
-\index{CYAN (src.colorama.ansi.AnsiFore attribute)}
+\item[{Return type}] \leavevmode
+dict
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
\end{fulllineitems}
-\index{GREEN (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
+Get the attibutes of the node node\_name in self.xmlroot
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node
-\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
+\item[{Returns}] \leavevmode
+the attibutes of the node node\_name in self.xmlroot
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+dict
-\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
\end{fulllineitems}
-\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
-\end{fulllineitems}
-
-\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description}
+\item[{Get the text of the first node that has name }] \leavevmode
+that corresponds to the parameter node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
-\end{fulllineitems}
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text
-\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
+\item[{Returns}] \leavevmode
+the text of the first node that has name
+that corresponds to the parameter node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+str
-\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
\end{fulllineitems}
-\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
\end{fulllineitems}
-\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{XmlLogFile (class in src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{XmlLogFile}}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
-\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
+Class to manage writing in salomeTools xml log file
+\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
-\index{RED (src.colorama.ansi.AnsiFore attribute)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
+attribute of the new node
-\index{RESET (src.colorama.ansi.AnsiFore attribute)}
+\end{itemize}
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
\end{fulllineitems}
-\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
+\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text
-\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
-\end{fulllineitems}
+\end{itemize}
+\end{description}\end{quote}
\end{fulllineitems}
-\index{AnsiStyle (class in src.colorama.ansi)}
+\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}}
-Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
-\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append
-\index{DIM (src.colorama.ansi.AnsiStyle attribute)}
+\end{itemize}
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}
-\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
+\index{write\_tree() (src.xmlManager.XmlLogFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file
-\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}
\end{fulllineitems}
-\index{clear\_line() (in module src.colorama.ansi)}
+\index{add\_simple\_node() (in module src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_line}}}{\emph{mode=2}}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.add_simple_node}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node
-\index{clear\_screen() (in module src.colorama.ansi)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_screen}}}{\emph{mode=2}}{}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
-\index{code\_to\_chars() (in module src.colorama.ansi)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
+attribute of the new node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{code\_to\_chars}}}{\emph{code}}{}
-\end{fulllineitems}
+\end{itemize}
-\index{set\_title() (in module src.colorama.ansi)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
\end{fulllineitems}
+\index{append\_node\_attrib() (in module src.xmlManager)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.append_node_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element
+where to append the new attibutes
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{ansitowin32}} Module}
-\label{\detokenize{commands/apidoc/src.colorama:ansitowin32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{AnsiToWin32}}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\end{itemize}
-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)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_CSI\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x4986ff0\textgreater{}}}}
\end{fulllineitems}
-\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+\index{find\_node\_by\_attrib() (in module src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_OSC\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x44e4620\textgreater{}}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.find_node_by_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{find\_node\_by\_attrib}}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}~\begin{description}
+\item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode
+its attributes \{key : value\}. Return the node
-\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search
-\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to search
-\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\end{itemize}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+the found node
-\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\item[{Return type}] \leavevmode
+xmlroot etree.Element
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{}
\end{fulllineitems}
-\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{write\_report() (in module src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.write_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create
-\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
-\end{fulllineitems}
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file
-\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\end{itemize}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{description}\end{quote}
\end{fulllineitems}
-\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
-\end{fulllineitems}
-\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\subsubsection{Module contents}
+\label{\detokenize{commands/apidoc/src:module-src}}\label{\detokenize{commands/apidoc/src:module-contents}}\index{src (module)}
+initial imports and utilities methods for salomeTools
+\index{Path (class in src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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.
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{Path}}}{\emph{path}}{}~\index{base() (src.Path method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
\end{fulllineitems}
-\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{chmod() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_plain\_text}}}{\emph{text}, \emph{start}, \emph{end}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
\end{fulllineitems}
+\index{copy() (src.Path method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
\end{fulllineitems}
-\index{StreamWrapper (class in src.colorama.ansitowin32)}
+\index{copydir() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{StreamWrapper}}}{\emph{wrapped}, \emph{converter}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
+\end{fulllineitems}
-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)}
+\index{copyfile() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
\end{fulllineitems}
+\index{copylink() (src.Path method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
\end{fulllineitems}
-\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
+\index{dir() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_a\_tty}}}{\emph{stream}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
\end{fulllineitems}
-\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
+\index{exists() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_stream\_closed}}}{\emph{stream}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
\end{fulllineitems}
-
-
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{initialise}} Module}
-\label{\detokenize{commands/apidoc/src.colorama:initialise-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.initialise}}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)}
+\index{isdir() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{colorama\_text}}}{\emph{*args}, \emph{**kwds}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
\end{fulllineitems}
-\index{deinit() (in module src.colorama.initialise)}
+\index{isfile() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
\end{fulllineitems}
-\index{init() (in module src.colorama.initialise)}
+\index{islink() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.init}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{init}}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
\end{fulllineitems}
-\index{reinit() (in module src.colorama.initialise)}
+\index{list() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
\end{fulllineitems}
-\index{reset\_all() (in module src.colorama.initialise)}
+\index{make() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
\end{fulllineitems}
-\index{wrap\_stream() (in module src.colorama.initialise)}
+\index{readlink() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{wrap\_stream}}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
\end{fulllineitems}
+\index{rm() (src.Path method)}
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
+\end{fulllineitems}
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{win32}} Module}
-\label{\detokenize{commands/apidoc/src.colorama:win32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.win32}}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}
+\index{smartcopy() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
\end{fulllineitems}
-\index{winapi\_test() (in module src.colorama.win32)}
+\index{symlink() (src.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
\end{fulllineitems}
+\end{fulllineitems}
-\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{winterm}} Module}
-\label{\detokenize{commands/apidoc/src.colorama:winterm-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.winterm}}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}
+\index{SatException}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
-\index{BLACK (src.colorama.winterm.WinColor attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{SatException}}}
+Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
+
+rename Exception Class
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}
-\index{BLUE (src.colorama.winterm.WinColor attribute)}
+\index{activate\_mesa\_property() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{}
+Add mesa property into application properties
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application!
-\index{CYAN (src.colorama.winterm.WinColor attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
\end{fulllineitems}
-\index{GREEN (src.colorama.winterm.WinColor attribute)}
+\index{check\_config\_has\_application() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.check_config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
-\index{GREY (src.colorama.winterm.WinColor attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
\end{fulllineitems}
-\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
+\index{check\_config\_has\_profile() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.check_config_has_profile}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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
+\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{RED (src.colorama.winterm.WinColor attribute)}
+\index{config\_has\_application() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
\end{fulllineitems}
-\index{YELLOW (src.colorama.winterm.WinColor attribute)}
+\index{deepcopy\_list() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
+Do a deep copy of a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy
+
+\item[{Returns}] \leavevmode
+The copy of the list
+
+\item[{Return type}] \leavevmode
+List
+\end{description}\end{quote}
\end{fulllineitems}
-\index{WinStyle (class in src.colorama.winterm)}
+\index{ensure\_path\_exists() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
-\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{}
+Create a path if not existing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path.
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}}
\end{fulllineitems}
-\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
+\index{find\_file\_in\_lpath() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.find_file_in_lpath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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{NORMAL (src.colorama.winterm.WinStyle attribute)}
+\index{get\_base\_path() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
-\end{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
+Returns the path of the products base.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} 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{WinTerm (class in src.colorama.winterm)}
+\index{get\_cfg\_param() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
-\index{back() (src.colorama.winterm.WinTerm method)}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_cfg_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{back}}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}
+\index{get\_launcher\_name() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cursor\_adjust}}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
+Returns the name of salome launcher.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
+
+\item[{Returns}] \leavevmode
+The name of salome launcher.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{erase\_line() (src.colorama.winterm.WinTerm method)}
+\index{get\_log\_path() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_line}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
+Returns the path of the logs.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
+
+\item[{Returns}] \leavevmode
+The path of the logs.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{erase\_screen() (src.colorama.winterm.WinTerm method)}
+\index{get\_property\_in\_product\_cfg() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_screen}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_property_in_product_cfg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_property\_in\_product\_cfg}}}{\emph{product\_cfg}, \emph{pprty}}{}
\end{fulllineitems}
-\index{fore() (src.colorama.winterm.WinTerm method)}
+\index{get\_salome\_version() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{fore}}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
\end{fulllineitems}
-\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
+\index{get\_tmp\_filename() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{}
\end{fulllineitems}
-\index{get\_position() (src.colorama.winterm.WinTerm method)}
+\index{handleRemoveReadonly() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
\end{fulllineitems}
-\index{reset\_all() (src.colorama.winterm.WinTerm method)}
+\index{merge\_dicts() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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{set\_attrs() (src.colorama.winterm.WinTerm method)}
+\index{only\_numbers() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
\end{fulllineitems}
-\index{set\_console() (src.colorama.winterm.WinTerm method)}
+\index{parse\_date() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_console}}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
+Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} 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{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
+\index{print\_info() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cursor\_position}}}{\emph{position=None}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{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 {}
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints.
+
+\item {}
+\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{set\_title() (src.colorama.winterm.WinTerm method)}
+\index{read\_config\_from\_a\_file() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.read_config_from_a_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{read\_config\_from\_a\_file}}}{\emph{filePath}}{}
\end{fulllineitems}
-\index{style() (src.colorama.winterm.WinTerm method)}
+\index{remove\_item\_from\_list() (in module src)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.remove_item_from_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{remove\_item\_from\_list}}}{\emph{input\_list}, \emph{item}}{}
+Remove all occurences of item from input\_list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} 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)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{commands/apidoc/src:src.replace_in_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{replace\_in\_file}}}{\emph{filein}, \emph{strin}, \emph{strout}}{}
+Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
\end{fulllineitems}
\begin{sphinxtheindex}
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
\bigletter{s}
-\item {\sphinxstyleindexentry{src.\_\_init\_\_}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.__init__}}
+\item {\sphinxstyleindexentry{src}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src}}
\item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.architecture}}
\item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama}}
\item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansi}}
\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}
\contentsline {subsubsection}{Compile SALOME}{6}{subsubsection*.13}
\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}
-\contentsline {section}{\numberline {2.1}Command config}{8}{section.2.1}
+\contentsline {section}{\numberline {2.1}Command doc}{8}{section.2.1}
\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}
\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2}
-\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3}
-\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2}
-\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1}
-\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2}
-\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14}
-\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15}
-\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3}
-\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4}
-\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3}
-\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1}
-\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2}
-\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3}
-\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4}
-\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1}
-\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2}
-\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3}
-\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5}
+\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}
+\contentsline {section}{\numberline {2.2}Command config}{9}{section.2.2}
+\contentsline {subsection}{\numberline {2.2.1}Description}{9}{subsection.2.2.1}
+\contentsline {subsection}{\numberline {2.2.2}Usage}{9}{subsection.2.2.2}
+\contentsline {subsection}{\numberline {2.2.3}Some useful configuration pathes}{10}{subsection.2.2.3}
+\contentsline {section}{\numberline {2.3}Command prepare}{11}{section.2.3}
+\contentsline {subsection}{\numberline {2.3.1}Description}{11}{subsection.2.3.1}
+\contentsline {subsection}{\numberline {2.3.2}Remarks}{11}{subsection.2.3.2}
+\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{11}{subsubsection*.14}
+\contentsline {subsubsection}{Dev mode}{11}{subsubsection*.15}
+\contentsline {subsection}{\numberline {2.3.3}Usage}{11}{subsection.2.3.3}
+\contentsline {subsection}{\numberline {2.3.4}Some useful configuration pathes}{12}{subsection.2.3.4}
+\contentsline {section}{\numberline {2.4}Command compile}{13}{section.2.4}
+\contentsline {subsection}{\numberline {2.4.1}Description}{13}{subsection.2.4.1}
+\contentsline {subsection}{\numberline {2.4.2}Usage}{13}{subsection.2.4.2}
+\contentsline {subsection}{\numberline {2.4.3}Some useful configuration pathes}{14}{subsection.2.4.3}
+\contentsline {section}{\numberline {2.5}Command launcher}{15}{section.2.5}
\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1}
\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2}
-\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3}
-\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6}
+\contentsline {subsection}{\numberline {2.5.3}Configuration}{15}{subsection.2.5.3}
+\contentsline {section}{\numberline {2.6}Command application}{16}{section.2.6}
\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1}
\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2}
\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3}
-\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7}
+\contentsline {section}{\numberline {2.7}Command log}{17}{section.2.7}
\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1}
\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2}
-\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3}
-\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8}
-\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1}
-\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2}
-\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3}
-\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4}
-\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9}
+\contentsline {subsection}{\numberline {2.7.3}Some useful configuration pathes}{17}{subsection.2.7.3}
+\contentsline {section}{\numberline {2.8}Command environ}{18}{section.2.8}
+\contentsline {subsection}{\numberline {2.8.1}Description}{18}{subsection.2.8.1}
+\contentsline {subsection}{\numberline {2.8.2}Usage}{18}{subsection.2.8.2}
+\contentsline {subsection}{\numberline {2.8.3}Configuration}{18}{subsection.2.8.3}
+\contentsline {section}{\numberline {2.9}Command clean}{21}{section.2.9}
\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1}
\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2}
-\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3}
-\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10}
-\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1}
-\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2}
-\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3}
+\contentsline {subsection}{\numberline {2.9.3}Availables options}{21}{subsection.2.9.3}
+\contentsline {subsection}{\numberline {2.9.4}Some useful configuration pathes}{21}{subsection.2.9.4}
+\contentsline {section}{\numberline {2.10}Command package}{22}{section.2.10}
+\contentsline {subsection}{\numberline {2.10.1}Description}{22}{subsection.2.10.1}
+\contentsline {subsection}{\numberline {2.10.2}Usage}{22}{subsection.2.10.2}
+\contentsline {subsection}{\numberline {2.10.3}Some useful configuration pathes}{23}{subsection.2.10.3}
+\contentsline {section}{\numberline {2.11}Command generate}{24}{section.2.11}
+\contentsline {subsection}{\numberline {2.11.1}Description}{24}{subsection.2.11.1}
+\contentsline {subsection}{\numberline {2.11.2}Remarks}{24}{subsection.2.11.2}
+\contentsline {subsection}{\numberline {2.11.3}Usage}{24}{subsection.2.11.3}
\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}
\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1}
\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1}
\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5}
\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4}
\contentsline {section}{\numberline {4.1}src}{29}{section.4.1}
-\contentsline {subsection}{\numberline {4.1.1}src Package}{29}{subsection.4.1.1}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{29}{subsubsection*.16}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{31}{subsubsection*.59}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{32}{subsubsection*.91}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{33}{subsubsection*.98}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{34}{subsubsection*.117}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{35}{subsubsection*.131}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{39}{subsubsection*.169}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{45}{subsubsection*.234}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{45}{subsubsection*.240}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{47}{subsubsection*.253}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{47}{subsubsection*.259}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{49}{subsubsection*.272}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{53}{subsubsection*.302}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{60}{subsubsection*.374}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{62}{subsubsection*.380}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{62}{subsubsection*.385}
-\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{62}{subsubsection*.405}
-\contentsline {subsubsection}{Subpackages}{64}{subsubsection*.419}
-\contentsline {paragraph}{colorama Package}{64}{paragraph*.420}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{64}{subparagraph*.421}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{64}{subparagraph*.423}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{66}{subparagraph*.476}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{67}{subparagraph*.494}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{67}{subparagraph*.501}
-\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{67}{subparagraph*.504}
+\contentsline {subsection}{\numberline {4.1.1}src package}{29}{subsection.4.1.1}
+\contentsline {subsubsection}{Subpackages}{29}{subsubsection*.16}
+\contentsline {paragraph}{src.colorama package}{29}{paragraph*.17}
+\contentsline {subparagraph}{Submodules}{29}{subparagraph*.18}
+\contentsline {subparagraph}{src.colorama.ansi module}{29}{subparagraph*.19}
+\contentsline {subparagraph}{src.colorama.ansitowin32 module}{31}{subparagraph*.72}
+\contentsline {subparagraph}{src.colorama.initialise module}{31}{subparagraph*.90}
+\contentsline {subparagraph}{src.colorama.win32 module}{32}{subparagraph*.97}
+\contentsline {subparagraph}{src.colorama.winterm module}{32}{subparagraph*.100}
+\contentsline {subparagraph}{Module contents}{33}{subparagraph*.128}
+\contentsline {subsubsection}{Submodules}{33}{subsubsection*.129}
+\contentsline {subsubsection}{src.ElementTree module}{33}{subsubsection*.130}
+\contentsline {subsubsection}{src.architecture module}{34}{subsubsection*.162}
+\contentsline {subsubsection}{src.compilation module}{34}{subsubsection*.169}
+\contentsline {subsubsection}{src.debug module}{35}{subsubsection*.188}
+\contentsline {subsubsection}{src.environment module}{36}{subsubsection*.202}
+\contentsline {subsubsection}{src.fileEnviron module}{40}{subsubsection*.240}
+\contentsline {subsubsection}{src.fork module}{46}{subsubsection*.305}
+\contentsline {subsubsection}{src.logger module}{46}{subsubsection*.311}
+\contentsline {subsubsection}{src.options module}{48}{subsubsection*.324}
+\contentsline {subsubsection}{src.printcolors module}{49}{subsubsection*.336}
+\contentsline {subsubsection}{src.product module}{50}{subsubsection*.349}
+\contentsline {subsubsection}{src.pyconf module}{55}{subsubsection*.379}
+\contentsline {subsubsection}{src.system module}{62}{subsubsection*.451}
+\contentsline {subsubsection}{src.template module}{63}{subsubsection*.457}
+\contentsline {subsubsection}{src.test\_module module}{63}{subsubsection*.462}
+\contentsline {subsubsection}{src.xmlManager module}{64}{subsubsection*.482}
+\contentsline {subsubsection}{Module contents}{66}{subsubsection*.496}
\contentsline {chapter}{\numberline {5}Release Notes}{69}{chapter.5}
\contentsline {section}{\numberline {5.1}Release notes}{69}{section.5.1}
-\contentsline {chapter}{Python Module Index}{71}{section*.532}
-\contentsline {chapter}{Index}{73}{section*.533}
+\contentsline {chapter}{Python Module Index}{71}{section*.538}
+\contentsline {chapter}{Index}{73}{section*.539}
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command doc
+****************
+
+Description
+===========
+The **doc** command displays sat documentation.
+
+Usage
+=====
+* Show (in a web browser) the sat documentation: ::
+
+ sat doc --html
+
+* Show (in evince, for example) the (same) sat documentation in format pdf: ::
+
+ sat doc --pdf
+
+* Edit and modify in your preference user editor the sources files (rst) of sat documentation: ::
+
+ sat doc --edit
+
+* get information how to compile locally sat documentation (from the sources files): ::
+
+ sat doc --compile
+
+
+
+Some useful configuration pathes
+=================================
+
+* **USER**
+
+ * **browser** : The browser used to show the html files (*firefox* for example).
+ * **pdf_viewer** : The viewer used to show the pdf files (*evince* for example).
+ * **editor** : The editor used to edit ascii text files (*pluma or gedit* for example).
+
.. toctree::
:maxdepth: 1
+ doc <commands/doc>
config <commands/config>
prepare <commands/prepare>
compile <commands/compile>
def __init__(self, source, events=None):
if not hasattr(source, "read"):
# OP TEST
- print "iterparse.__init__ source = %s" %source
+ print("iterparse.__init__ source = %s" % source)
source = open(source, "rb")
self._file = source
self._events = []
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-'''The Options class that manages the access to all options passed as
- parameters in salomeTools command lines
-'''
+
+"""
+The Options class that manages the access to all options passed as
+parameters in salomeTools command lines
+"""
+
import getopt
import sys
+import pprint as PP
+
from . import printcolors
+import src
+import src.debug as DBG # Easy print stderr (for DEBUG only)
+
class OptResult(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
- '''
+ """
+ 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.
+
+ | Example:
+ | >> options, remainderArgs = command.parseArguments(args)
+ | >> print(options.output_verbose_level)
+ | >> 'INFO'
+ """
def __init__(self):
- '''Initialization
- '''
+ """Initialization
+ """
self.__dict__ = dict()
def __getattr__(self, name):
- '''Overwrite of the __getattr__ function
- to customize it for option usage
+ """
+ Overwrite of the __getattr__ function
+ to customize it for option usage
- :param name str: The attribute to get the value.
- :return: the value corresponding to the attribute.
- :rtype: str,int,list,boolean
- '''
+ :param name: (str) The attribute to get the value.
+ :return: (str int list boolean level)
+ the value corresponding to the attribute.
+ """
if name in self.__dict__:
return self.__dict__[name]
else:
- raise AttributeError(name + _(u" is not a valid option"))
+ raise AttributeError("--" + name + _(u" is not a valid option"))
def __setattr__(self, name, value):
- '''Overwrite of the __setattr__ function
- to customize it for option usage
+ """
+ Overwrite of the __setattr__ function
+ to customize it for option usage
- :param name str: The attribute to set.
- :param value str: The value corresponding to the attribute.
- :return: Nothing.
- :rtype: N\A
- '''
- object.__setattr__(self,name,value)
-
-class Options:
- '''Class to manage all salomeTools options
- '''
+ :param name: (str) The attribute to set.
+ :param value: (str) The value corresponding to the attribute.
+ :return: None
+ """
+ object.__setattr__(self, name, value)
+
+ def __repr__(self):
+ aStr = PP.pformat(self.__dict__)
+ res = "%s(\n %s\n)" % (self.__class__.__name__, aStr[1:-1])
+ return res
+
+class Options(object):
+ """
+ Class to manage all salomeTools options
+ """
def __init__(self):
- '''Initialization
- '''
+ """Initialization
+ """
# The options field stocks all options of a command
# in a list that contains dicts
self.options = []
# The list of available option type
- self.availableOptions = ["boolean", "string", "int", "float",
- "long", "list", "list2"]
+ self.availableOptions = "noboolean boolean string int float long list list2 level".split()
+ self.noArgOptions = "noboolean boolean".split()
self.default = None
+ self.results = {}
- def add_option(self, shortName, longName,
- optionType, destName, helpString="", default = None):
- '''Method to add an option to a command. It gets all attributes
- of an option and append it in the options field
+ def add_option(self, shortName, longName, optionType, destName, helpString="", default=None):
+ """
+ Add an option to a command. It gets all attributes
+ of an option and append it in the options field
- :param shortName str: The short name of the option
- (ex "l" for level option).
- :param longName str: The long name of the option
- (ex "level" for level option).
- :param optionType str: The type of the option (ex "int").
- :param destName str: The name that will be used in the code.
- :param helpString str: The text to display
- when user ask for help on a command.
- :return: Nothing.
- :rtype: N\A
- '''
+ :param shortName: (str)
+ The short name of the option (as '-l' for level option).
+ :param longName: (str)
+ The long name of the option (as '--level' for level option).
+ :param optionType: (str) The type of the option (ex "int").
+ :param destName: (str) The name that will be used in the code.
+ :param helpString: (str)
+ The text to display when user ask for help on a command.
+ :return: None
+ """
+ tmp = [o['shortName'] for o in self.options if o['shortName'] != '']
+ if shortName in tmp:
+ raise Exception("option '-%s' existing yet" % shortName)
+ tmp = [o['longName'] for o in self.options if o['longName'] != '']
+ if longName in tmp:
+ raise Exception("option '--%s' existing yet" % longName)
+
option = dict()
option['shortName'] = shortName
option['longName'] = longName
if optionType not in self.availableOptions:
- print("error optionType", optionType, "not available.")
- sys.exit(-1)
+ raise Exception("error optionType '%s' not available." % optionType)
option['optionType'] = optionType
option['destName'] = destName
option['helpString'] = helpString
option['result'] = default
+
self.options.append(option)
+
+ def getDetailOption(self, option):
+ """
+ for convenience
+
+ :return: (tuple) 4-elements (shortName, longName, optionType, helpString)
+ """
+ oos = option['shortName']
+ ool = option['longName']
+ oot = option['optionType']
+ ooh = option['helpString']
+ return (oos, ool, oot, ooh)
- def print_help(self):
- '''Method that display all options stored in self.options and there help
+ def get_help(self):
+ """
+ Returns all options stored in self.options
+ as help message colored string
- :return: Nothing.
- :rtype: N\A
- '''
+ :return: (str) colored string
+ """
+ msg = ""
# Do nothing if there are no options
if len(self.options) == 0:
- return
+ return _("No available options.")
- # for all options, print its values.
- # "shortname" is an optional field of the options
- print(printcolors.printcHeader(_("Available options are:")))
+ # for all options, gets its values.
+ # "shortname" is an mandatory field of the options, could be ''
+ msg += printcolors.printcHeader(_("Available options are:"))
for option in self.options:
- if 'shortName' in option and len(option['shortName']) > 0:
- print(" -%(shortName)1s, --%(longName)s"
- " (%(optionType)s)\n\t%(helpString)s\n" % option)
+ oos, ool, oot, ooh = self.getDetailOption(option)
+ if len(oos) > 0:
+ msg += "\n -%1s, --%s (%s)\n" % (oos, ool, oot)
else:
- print(" --%(longName)s (%(optionType)s)\n\t%(helpString)s\n"
- % option)
+ msg += "\n --%s (%s)\n" % (ool, oot)
+
+ msg += "%s\n" % self.indent(ooh, 10)
+ return msg
+ def print_help(self):
+ """
+ Method that display all options stored in self.options and there help
+
+ :return: None
+ """
+ print(self.get_help())
+ return
+
+ def indent(self, text, amount, car=" "):
+ """indent multi lines message"""
+ padding = amount * car
+ return ''.join(padding + line for line in text.splitlines(True))
+
def parse_args(self, argList=None):
- '''Method that instantiates the class OptResult
- that gives access to all options in the code
+ """
+ Instantiates the class OptResult
+ that gives access to all options in the code
- :param argList list: the raw list of arguments that were passed
- :return: optResult, args : optResult is the option instance
- to manipulate in the code. args
- is the full raw list of passed options
- :rtype: (class 'common.options.OptResult',list)
- '''
+ :param argList: (list) the raw list of arguments that were passed
+ :return: (OptResult, list) as (optResult, args)
+ optResult is the option instance to manipulate in the code.
+ args is the full raw list of passed options
+ """
+ # see https://pymotw.com/2/getopt/
if argList is None:
argList = sys.argv[1:]
+ DBG.write("parse_args", argList)
+ # DBG.write("options", self.options)
# format shortNameOption and longNameOption
# to make right arguments to getopt.getopt function
shortNameOption = ""
longNameOption = []
for option in self.options:
shortNameOption = shortNameOption + option['shortName']
- if option['shortName'] != "" and option['optionType'] != "boolean":
+ if option['shortName'] != "" and option['optionType'] not in self.noArgOptions:
shortNameOption = shortNameOption + ":"
if option['longName'] != "":
- if option['optionType'] != "boolean":
+ if option['optionType'] not in self.noArgOptions:
longNameOption.append(option['longName'] + "=")
else:
longNameOption.append(option['longName'])
# call to getopt.getopt function to get the option
# passed in the command regarding the available options
- optlist, args = getopt.getopt(argList, shortNameOption, longNameOption)
-
+ try:
+ optlist, args = getopt.getopt(argList, shortNameOption, longNameOption)
+ except Exception as e:
+ msg = str(e) + " on '%s'\n\n" % " ".join(argList) + self.get_help()
+ raise Exception(msg)
+
# instantiate and completing the optResult that will be returned
optResult = OptResult()
for option in self.options:
option['result'] = opt[1]
elif optionType == "boolean":
option['result'] = True
+ elif optionType == "noboolean":
+ option['result'] = False
elif optionType == "int":
option['result'] = int(opt[1])
elif optionType == "float":
if option['result'] is None:
option['result'] = list()
option['result'].append(opt[1])
+ elif optionType == "level": #logger logging levels
+ option['result'] = self.filterLevel(opt[1])
elif optionType == "list2":
if option['result'] is None:
option['result'] = list()
- if opt[1].find(",") == -1:
- option['result'].append(opt[1])
- else:
- elts = filter(lambda l: len(l) > 0, opt[1].split(","))
- option['result'].extend(elts)
+ option['result'] = self.filterList2(opt[1])
optResult.__setattr__(option['destName'], option['result'])
# free the option in order to be able to make
# a new free call of options (API case)
option['result'] = None
+
+ self.results = {"optlist": optlist, "optResult": optResult, "args": args, "argList": argList}
+ DBG.write("results", self.results)
return optResult, args
+
+ def filterLevel(self, aLevel):
+ """filter level logging values"""
+ import src.loggingSat as LOG
+ aLev = aLevel.upper()
+ knownLevels = LOG._knownLevels
+ maxLen = max([len(i) for i in knownLevels])
+ for i in range(maxLen):
+ for lev in knownLevels:
+ if aLev == lev[:i]:
+ DBG.write("filterLevel", "%s -> %s" % (aLevel, lev))
+ return lev
+ msg = "Unknown level '%s', accepted are:\n%s" % (aLev, ", ".join(knownLevels))
+ raise Exception(msg)
+
+ def filterList2(self, aStr):
+ """filter a list as 'KERNEL,YACS,etc.'"""
+ aList = aStr.strip().split(",")
+ return aList
+
+
+ def __repr__(self):
+ """
+ repr for only self.options and self.results (if present)
+ """
+ aDict = {'options': self.options, 'results': self.results}
+ aStr = PP.pformat(aDict)
+ res = "%s(\n %s\n)" % (self.__class__.__name__, aStr[1:-1])
+ return res
+
+ def __str__(self):
+ """
+ str for only resume expected self.options
+ """
+ #aDict = [(k["longName"], k["shortName", k["helpString"]) for k in self.options}
+ #aList = [(k, self.options[k]) for k in sorted(self.options.keys())]
+ aDict = {}
+ for o in self.options:
+ aDict[o["longName"]] = (o["shortName"], o["helpString"])
+ aStr = PP.pformat(aDict)
+ res = "%s(\n %s)" % (self.__class__.__name__, aStr[1:-1])
+ return res
+
+ def debug_write(self):
+ DBG.write("options and results", self, True)
+
